Appearance
Create deposit references in bulk​
POST
/v2/wallet/fiat/{currency}/payment/bulk-references
Requires COLLECTIONS_CREATE, granted by COLLECTIONS_WRITE (bundles)
Starts a background job that creates a deposit reference for each payer in senders and returns its jobId; if any payer is invalid or the batch would take you past your reference limits, the whole batch is rejected. Poll Get a bulk reference job until status is no longer PROCESSING, then list the job's items to get each payer's reference code.
Parameters​
Path Parameters
currency*
Fiat currency of the references, e.g. ZAR.
Type
Requiredstring
Example
"ZAR"Request Body​
application/json
JSON
{
"senders": [
{
"name": "Thandi Nkosi",
"email": "thandi@example.com",
"expectedAmount": "1500"
},
{
"name": "Pieter van der Merwe",
"email": "pieter@example.com"
}
]
}
Responses​
Created
application/json
JSON
{
"jobId": 4182,
"totalItems": 2,
"acceptedItems": 2
}
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | -113INVALID_JSON | The body isn't valid JSON. |
| 400 | -11INVALID_REQUEST | The body is empty or a field fails validation; validationErrors lists each failing field. |
| 400 | -15121BULK_DEPOSIT_REFERENCE_BATCH_TOO_LARGE | senders has more payers than a single batch allows. Split them into smaller batches. |
| 400 | -15721SCOPED_DEPOSIT_ACCOUNT_CURRENCY_MISMATCH | Your collections account doesn't support this currency. |
| 400 | -15123BULK_DEPOSIT_REFERENCE_INVALID_SENDER | An entry in senders is null, a payer's name or email is missing or invalid, or their expected amount isn't a number greater than zero; the message identifies up to three such payers by their position in senders, and no job is created. |
| 409 | -15124BULK_DEPOSIT_REFERENCE_JOB_IN_PROGRESS | An earlier bulk job is still processing. Wait for it to finish, then try again. |
| 429 | -15119UNIQUE_DEPOSIT_REFERENCE_OVERALL_LIMIT_EXCEEDED | The batch would take you past the maximum number of references. Delete references you no longer need or submit fewer payers. |
| 429 | -15116UNIQUE_DEPOSIT_REFERENCE_RATE_LIMIT_EXCEEDED | The batch would take you past the daily limit for creating references. Submit fewer payers or try again tomorrow. |
| 503 | -15120BULK_DEPOSIT_REFERENCE_FEATURE_DISABLED | Bulk deposit references are temporarily unavailable. |
Plus the errors common to all signed endpoints.