Skip to content

List credited deposits​

GET
/v2/wallet/fiat/{currency}/payment/deposits

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Lists the deposits credited to your collections account in this currency, newest first, with the reference each one is linked to. Use it to find a deposit's publicId when you want to link it to a different reference.

Parameters​

Path Parameters

currency*

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

Type
string
Required
Example"ZAR"

Query Parameters

skip

Number of results to skip, for paging.

Type
integer
Example0
Default
0
limit

Maximum number of deposits to return. Values above 1000 are treated as 1000.

Type
integer
Example20
Default
20

Responses​

OK

application/json
JSON
{
"items": [
{
"publicId": "3f1c2a9e-8b4d-4c1e-9f2a-6d7e8b9c0a1b",
"amount": "1500",
"effectiveDate": "2026-10-23",
"creditedAt": 1792746900000,
"linkedReferenceCode": "VPAY-7K2Q9RT"
},
{
"publicId": "9a7b6c5d-4e3f-4a2b-8c1d-0e9f8a7b6c5d",
"amount": "820.5",
"effectiveDate": "2026-10-22",
"creditedAt": 1792675200000
}
],
"total": 2,
"limit": 20,
"offset": 0
}

Samples​

Errors

HTTPErrorWhen
400-11INVALID_REQUESTskip or limit isn't a whole number, or the currency isn't recognised.
400-15721SCOPED_DEPOSIT_ACCOUNT_CURRENCY_MISMATCHYour collections account doesn't support this currency.
503-15117UNIQUE_DEPOSIT_REFERENCES_FEATURE_DISABLEDDeposit references are temporarily unavailable.

Plus the errors common to all signed endpoints.