API Reference

Check Status API

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

Request body

📘

Note:

Encryption or decryption methodology is AES-192-CBC bits encryption.

ParameterDescriptionExample
Encrypted
token
mandatory		String Token is the Encrypted body of the below request AES-192-CBC bits Encryption 

Decrypted

messageCode
mandatory		Numeric Code to Identify load card request type.
Character Limit - 4		1080
clientTxnId
mandatory		String Unique ID generated by the client for each transaction.
Character Limit - 14		GOUd789hhhjfscs
requestDateTime
mandatory		Numeric Local Date and time stamp when the transaction originated from the client in YYYYMMDDHHMMSS with time in 24 hr format. Character Limit - 1420230511100234
verifyclientTxnId
mandatory		String The value of “clientTxnId” passed in the request body of the API call for which response dump is needed. Character Limit - 100rsa0w07saf35869xhstiesq
fromDate
optional		String The initial value for time range in which to search for the transaction, in YYYY-MM-DD format. Character Limit - 102022-06-10
toDate
optional		String The ending value for time range in which to search for the transaction, in YYYY-MM-DD format.
Character Limit - 10		2022-06-20

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

ParameterDescriptionSample value

Encypted

tokenToken is the Encrypted body of the below request AES-192-CBC bits EncryptionPl8F5kDZcvADIiursiAvv
bHNuL9Wv5eaFdorGVFU6F
KfIEnV/YskkzJlAov2ZHJ
WnqGNLOXfBq4SQqw8Ep4
sK0gCAAkRXATCb1nSY6s=

Decypted

messageCodeCode to Identity “Mobile Number based Card Inquiry” API response2051
clientTxnIdUnique Id generated by the client for each transaction. This value must be unique for every API call20150701235959xhstiesqfds
responseDateTimeResponse date time in the format YYYYMMDDHHMMSS with time in 24 hr format20161031214559
responseCodeContains the status of the transaction. 00 indicates success. Please refer Appendix for other response codes0
bankIdBank Id is provided by Prepaid Aero during program enrolment to uniquely identify the card issuer.7000
responseDumpWill contain the response dump of the transaction, or error message.Refer below the table.

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 CodeDescription
1055MALFORMED_REQUEST
1085PRODUCT NOT ALLOWED
1052SYSTEM_ERROR
1032INVALID_CLIENT_CHANNEL
1081OPERATION NOT ALLOWED
1080IP_NOT_ALLOWED
1049INVALID SECURE CODE
1051CHECKSUM FAILURE
1093INVALID CLIENT TXN ID
1320REQUEST_DATETIME_IS_MANDATORY
1031INVALID BANK ID
1264BANK ID NOT PRESENT
1262CLIENT ID NOT PRESENT
1310XCONSUMERKEY NOT PRESENT
1030INVALID MESSAGE
1311SECURE CODE NOT PRESENT
1088INVALID DATE FORMAT
29201NO API RESPONSE DUMP AVAILABLE FOR THE CLIENT TXN ID
29301FROM AND TO-DATE RANGE OUT OF BOUND

HTTP error codes

HTTP Status CodeHTTP Status Description
201Created
200OK
404Not Found
500Internal Server Error
400Bad 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 \"}"
] }