Collection status
Whether the amount has been credited to the right loan or customer account.
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/{collectionId}📘 RECEIVED is not yet CREDITED
Headers
AuthorizationstringrequiredBearer <your API key>. Sandbox and production keys are separate.
Content-Typestringrequiredapplication/json on every request that has a body.
Path parameters
collectionIdstringrequiredFrom register collection.
Response fields
statusstringrequiredRECEIVED, CREDITED or REVERSED.
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.