Appearance
Update a deposit reference​
PUT
/v2/wallet/fiat/{currency}/payment/references/{referenceCode}
Requires COLLECTIONS_UPDATE, granted by COLLECTIONS_WRITE (bundles)
Updates the expected amount, payer name or payer email of a deposit reference; fields you leave out keep their current values. The response includes matchedDepositCount but not the matched deposits themselves.
Parameters​
Path Parameters
currency*
Fiat currency of the reference, e.g. ZAR.
Type
Requiredstring
Example
"ZAR"referenceCode*
The reference code returned when the reference was created.
Type
Requiredstring
Example
"VPAY-7K2Q9RT"Request Body​
application/json
JSON
{
"expectedAmount": "2000",
"email": "thandi.nkosi@example.com"
}
Responses​
OK
application/json
JSON
{
"referenceCode": "VPAY-7K2Q9RT",
"currency": "ZAR",
"expectedAmount": "2000",
"createdAt": 1792742400000,
"name": "Thandi Nkosi",
"email": "thandi.nkosi@example.com",
"matchedDeposits": [
],
"matchedDepositCount": 1
}
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | -113INVALID_JSON | The body isn't valid JSON. |
| 400 | -11INVALID_REQUEST | The body is empty or a field fails validation; validationErrors lists each failing field. |
| 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.