Appearance
Create a deposit reference​
POST
/v2/wallet/fiat/{currency}/payment/references
Requires COLLECTIONS_CREATE, granted by COLLECTIONS_WRITE (bundles)
Creates a unique deposit reference for a payer. Give the reference to the payer; deposits that quote it are matched to it. You can record the amount you expect and the payer's name and email to help you reconcile deposits.
Parameters​
Path Parameters
currency*
Fiat currency of the reference, e.g. ZAR.
Type
Requiredstring
Example
"ZAR"Request Body​
application/json
JSON
{
"expectedAmount": "1500",
"name": "Thandi Nkosi",
"email": "thandi@example.com"
}
Responses​
Created
application/json
JSON
{
"referenceCode": "string",
"currency": "string",
"expectedAmount": "string",
"createdAt": 0,
"name": "string",
"email": "string",
"matchedDeposits": [
{
"publicId": "string",
"amount": "string",
"effectiveDate": "string",
"creditedAt": 0,
"isOverride": true
}
],
"matchedDepositCount": 0
}
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 | -15721SCOPED_DEPOSIT_ACCOUNT_CURRENCY_MISMATCH | Your collections account doesn't support this currency. |
| 429 | -15116UNIQUE_DEPOSIT_REFERENCE_RATE_LIMIT_EXCEEDED | You've reached the daily limit for creating references. |
| 429 | -15119UNIQUE_DEPOSIT_REFERENCE_OVERALL_LIMIT_EXCEEDED | You've reached the maximum number of references. |
| 503 | -15117UNIQUE_DEPOSIT_REFERENCES_FEATURE_DISABLED | Deposit references are temporarily unavailable. |
Plus the errors common to all signed endpoints.