Appearance
List deposit references​
GET
/v2/wallet/fiat/{currency}/payment/references
Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)
Lists your deposit references in this currency, newest first, with the number of deposits matched to each; get a single reference to see the deposits themselves. Pass query to search by reference code, payer name or payer email instead, with the best matches first.
Parameters​
Path Parameters
currency*
Fiat currency of the references, e.g. ZAR.
Type
Requiredstring
Example
"ZAR"Query Parameters
matched
true for references with at least one matched deposit, false for references with none. Leave it out to return both.
Type
boolean
Example
truequery
Search text: a full reference code for an exact match, or part of a payer's name or email for a fuzzy match. Shorter than two characters returns no results.
Type
string
Example
"Thandi"name
Same as query; used only when query isn't set.
Type
string
Example
"Thandi"email
Same as query; used only when neither query nor name is set.
Type
string
Example
"thandi@example.com"skip
Number of results to skip, for paging.
Type
integer
Example
0Default
0limit
Maximum number of references to return. Values above 1000 are treated as 1000.
Type
integer
Example
100Default
100Responses​
OK
application/json
JSON
{
"items": [
{
"referenceCode": "VPAY-7K2Q9RT",
"currency": "ZAR",
"expectedAmount": "1500",
"createdAt": 1792742400000,
"name": "Thandi Nkosi",
"email": "thandi@example.com",
"matchedDeposits": [
],
"matchedDepositCount": 1
},
{
"referenceCode": "VPAY-M4XH8WD",
"currency": "ZAR",
"createdAt": 1792571400000,
"name": "Pieter van der Merwe",
"email": "pieter@example.com",
"matchedDeposits": [
],
"matchedDepositCount": 0
}
],
"total": 2,
"limit": 100,
"offset": 0,
"truncated": false
}
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | -11INVALID_REQUEST | matched isn't true or false, skip or limit isn't a whole number, query, name or email is empty or too long, or the currency isn't recognised. |
| 400 | -15721SCOPED_DEPOSIT_ACCOUNT_CURRENCY_MISMATCH | Your collections account doesn't support this currency. |
| 503 | -15117UNIQUE_DEPOSIT_REFERENCES_FEATURE_DISABLED | Deposit references are temporarily unavailable. |
Plus the errors common to all signed endpoints.