Appearance
Link a deposit to a reference​
PUT
/v2/wallet/fiat/{currency}/payment/deposits/{publicId}/reference
Requires COLLECTIONS_UPDATE, granted by COLLECTIONS_WRITE (bundles)
Links a credited deposit to one of your deposit references, replacing any reference it was already matched to. Use it to correct which payer a deposit is attributed to; the funds stay where they are.
Parameters​
Path Parameters
currency*
Fiat currency of the deposits, e.g. ZAR.
Type
Requiredstring
Example
"ZAR"publicId*
The deposit's publicId.
Type
Requiredstring
Example
"3f1c2a9e-8b4d-4c1e-9f2a-6d7e8b9c0a1b"Format
"uuid"Request Body​
application/json
JSON
{
"referenceCode": "VPAY-7K2Q9RT"
}
Responses​
No content
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. |
| 400 | -15115UNIQUE_DEPOSIT_REFERENCE_INVALID_OVERRIDE | The deposit hasn't been fully credited yet. |
| 404 | -15118FIAT_DEPOSIT_NOT_FOUND | No deposit with this ID exists on your collections account. |
| 404 | -15114UNIQUE_DEPOSIT_REFERENCE_NOT_FOUND | No reference with this code exists on your account. |
Plus the errors common to all signed endpoints.