Appearance
Get a bulk reference job​
GET
/v2/wallet/fiat/{currency}/payment/bulk-references/{jobId}
Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)
Returns the status of a bulk reference job. completedItems and failedItems are filled in when the job finishes; while it's PROCESSING, list the job's items to follow its progress.
Parameters​
Path Parameters
currency*
Fiat currency of the references, e.g. ZAR.
Type
Requiredstring
Example
"ZAR"jobId*
The jobId returned when the bulk job was created.
Type
Requiredinteger
Example
4182Format
"int64"Responses​
OK
application/json
JSON
{
"jobId": 0,
"status": "string",
"totalItems": 0,
"acceptedItems": 0,
"completedItems": 0,
"failedItems": 0,
"createdAt": "string",
"completedAt": "string"
}
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | -11INVALID_REQUEST | The job ID isn't a whole number, or the currency isn't recognised. |
| 400 | -15721SCOPED_DEPOSIT_ACCOUNT_CURRENCY_MISMATCH | Your collections account doesn't support this currency. |
| 404 | -15122BULK_DEPOSIT_REFERENCE_JOB_NOT_FOUND | No bulk job with this ID exists on your account for this currency. |
| 503 | -15120BULK_DEPOSIT_REFERENCE_FEATURE_DISABLED | Bulk deposit references are temporarily unavailable. |
Plus the errors common to all signed endpoints.