Get a deposit reference

GET

/v2/wallet/fiat/{currency}/payment/references/{referenceCode}

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Returns a deposit reference and the deposits that have been matched to it.

Parameters

Path Parameters

currency*

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

Type

string

Required

Example"ZAR"

referenceCode*

The reference code returned when the reference was created.

Type

string

Required

Example"VPAY-7K2Q9RT"

Responses

OK

Content-Type

application/json

{

"referenceCode": "VPAY-7K2Q9RT",

"currency": "ZAR",

"expectedAmount": "1500",

"createdAt": 1792742400000,

"name": "Thandi Nkosi",

"email": "thandi@example.com",

"matchedDeposits": [

{

"publicId": "3f1c2a9e-8b4d-4c1e-9f2a-6d7e8b9c0a1b",

"amount": "1500",

"effectiveDate": "2026-10-23",

"creditedAt": 1792746000000,

"isOverride": false

}

],

"matchedDepositCount": 1

}

Samples

Errors

HTTP	Error	When
404	-15114UNIQUE_DEPOSIT_REFERENCE_NOT_FOUND	No reference with this code exists on your account.
503	-15117UNIQUE_DEPOSIT_REFERENCES_FEATURE_DISABLED	Deposit references are temporarily unavailable.

Plus the errors common to all signed endpoints.