Business API

Appearance

List bulk reference job items​

GET
/v2/wallet/fiat/{currency}/payment/bulk-references/{jobId}/items

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Lists the payers in a bulk reference job in the order they were submitted, with the reference created for each or, if creation failed, an errorCode. Filter by status to fetch only the references that were created, that failed or that are still pending.

Parameters​

Path Parameters

currency*

Fiat currency of the references, e.g. ZAR.

Type
string
Required
Example"ZAR"
jobId*

The jobId returned when the bulk job was created.

Type
integer
Required
Example4182
Format
"int64"

Query Parameters

status

Only return items with this status. Case-insensitive.

Type
string
Valid values
"PENDING""SUCCESS""FAILED"
Example"FAILED"
skip

Number of results to skip, for paging.

Type
integer
Example0
Default
0
limit

Maximum number of items to return, between 1 and 1000; values outside that range are clamped.

Type
integer
Example100
Default
100

Responses​

OK

application/json
JSON
{
"items": [
{
"senderIndex": 0,
"currency": "ZAR",
"expectedAmount": "1500",
"name": "Thandi Nkosi",
"email": "thandi@example.com",
"status": "SUCCESS",
"referenceCode": "VPAY-7K2Q9RT",
"processedAt": 1792749605000
},
{
"senderIndex": 1,
"currency": "ZAR",
"name": "Pieter van der Merwe",
"email": "pieter@example.com",
"status": "FAILED",
"errorCode": -15116,
"processedAt": 1792749606000
}
],
"total": 2,
"limit": 100,
"offset": 0
}

Samples​

Errors

HTTPErrorWhen
400-11INVALID_REQUESTThe job ID, skip or limit isn't a whole number, status isn't PENDING, SUCCESS or FAILED, or the currency isn't recognised.
400-15721SCOPED_DEPOSIT_ACCOUNT_CURRENCY_MISMATCHYour collections account doesn't support this currency.
404-15122BULK_DEPOSIT_REFERENCE_JOB_NOT_FOUNDNo bulk job with this ID exists on your account for this currency.
503-15120BULK_DEPOSIT_REFERENCE_FEATURE_DISABLEDBulk deposit references are temporarily unavailable.

Plus the errors common to all signed endpoints.