Register collection
Records a cash deposit captured at the counter against your account reference.
Sample reference
This shows the shape of the call — the operation, its fields and what comes back. The exact paths, base URL and any extra fields are confirmed with your sandbox credentials.
{BASE_URL}/v1/cms/collections🚧 One collection, one clientReference
Headers
AuthorizationstringrequiredBearer <your API key>. Sandbox and production keys are separate.
Content-Typestringrequiredapplication/json on every request that has a body.
Request body
accountReferencestringrequiredYour loan or customer account number.
amountnumberrequiredIn rupees.
agentIdstringrequiredThe collection point that took the cash.
clientReferencestringrequiredYour own unique ID for this collection.
Response fields
collectionIdstringrequiredUse it to check status and to match against reconciliation.
statusstringrequiredRECEIVED, then CREDITED once it lands on the account.
Values of status
| Value | Meaning |
|---|---|
| RECEIVED | Cash taken at the counter, not yet on the account. |
| CREDITED | Landed on the loan or customer account. |
| REVERSED | A credited collection was reversed. |
Errors
Every API returns the same envelope on failure, so one handler covers the whole catalogue.
VALIDATION_ERRORA field is missing or malformed. The message names the field.
UNAUTHORIZEDThe API key is missing, wrong, or for the other environment.
NOT_FOUNDNo resource with that ID or reference exists.
DUPLICATE_REFERENCEThis clientReference was already used. Safe to treat as a repeat of the first call.
RATE_LIMITEDToo many requests. Back off and retry after the Retry-After header.
UPSTREAM_UNAVAILABLEThe biller, bank or network is down. Retry later; nothing was charged.