This API will fetch the response dump for any API call based on the value of clientTxnId field.
Environment: https://domain/mob1/api/onboarding/v1/checkStatus
HTTP Method: POST
Request parameters
Header
| Parameter | Description | Example |
|---|---|---|
| x-api-key mandatory | String This is a unique key. | 7fe1c0de |
| clientId mandatory | String Uniquely identifies the client. During program enrolment each client is provided with a unique client id by Prepaid | 2000 |
| bankId mandatory | Numeric Bank Id is provided by Prepaid Aero during program enrolment to uniquely identify the card issuer. | 7000 |
| entityId mandatory | Numeric Defaults to parent branch i.e., 100 | 100 |
| secureCode mandatory | String Uniquely identifies the client on payload level for performing operations. | AfYtlO5kqdySIjXyNmGg3F |
Request body
Note:
Encryption or decryption methodology is AES-192-CBC bits encryption.
Sample request
Packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”
}
Packet sample (Decrypted)
{
"messageCode": 2050,
"clientTxnId": "checkStatus0173c", "requestDateTime": "20230620123143", "verifyclientTxnId": "ChangecardStatus000015", "fromDate": "2022-06-10",
"toDate": "2022-06-20"
}
Response parameters
responseDump example
[
“{\”urn\”:70000000008,\”customerId\”:\”128918\”,\”responseCode\”:\”00\”,\”messageCode\”:3011,\”clientTxnId\”:\”ChangecardStatus000015\”,\”clientId\”:\”1040\”,\”responseDateTime\”:\”20230622145005\”,\”responseMessage\”:\”SUCCESS\”,\”bankId\”:6010,\”accosaRefNo\”:\”41072\”}”
]
API error codes
| Error Code | Description |
|---|---|
| 1055 | MALFORMED_REQUEST |
| 1085 | PRODUCT NOT ALLOWED |
| 1052 | SYSTEM_ERROR |
| 1032 | INVALID_CLIENT_CHANNEL |
| 1081 | OPERATION NOT ALLOWED |
| 1080 | IP_NOT_ALLOWED |
| 1049 | INVALID SECURE CODE |
| 1051 | CHECKSUM FAILURE |
| 1093 | INVALID CLIENT TXN ID |
| 1320 | REQUEST_DATETIME_IS_MANDATORY |
| 1031 | INVALID BANK ID |
| 1264 | BANK ID NOT PRESENT |
| 1262 | CLIENT ID NOT PRESENT |
| 1310 | XCONSUMERKEY NOT PRESENT |
| 1030 | INVALID MESSAGE |
| 1311 | SECURE CODE NOT PRESENT |
| 1088 | INVALID DATE FORMAT |
| 29201 | NO API RESPONSE DUMP AVAILABLE FOR THE CLIENT TXN ID |
| 29301 | FROM AND TO-DATE RANGE OUT OF BOUND |
HTTP error codes
| HTTP Status Code | HTTP Status Description |
|---|---|
| 201 | Created |
| 200 | OK |
| 404 | Not Found |
| 500 | Internal Server Error |
| 400 | Bad Request |
Sample response
Packet sample (Encrypted)
{
“token”:"Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/YskkzJlAov2ZHJWnqGNLOXfBq4SQqw8Ep4sK0gCAAkRXATCb1nSY6s="
}
Sample (Decrypted)
- Success Scenario
{
"urn": 70000000008,
"responseCode": "00",
"messageCode": 2051,
"clientTxnId": "ChangecardStatus000015", "bankId": 7000,
"response_dump": [
"{\"urn\":70000000008,\"customerId\":\"128918\",\"responseCode\":\"00\",\"messageCode\":30 11,\"clientTxnId\":\"ChangecardStatus000015\",\"clientId\":\"1040\",\"responseDateTime\":\"2 0230622145005\",\"responseMessage\":\"SUCCESS\",\"bankId\":6010,\"accosaRefNo\":\"41072 \"}"
] }