Statement Inquiry API

Statement Inquiry API is called by the client to fetch the relevant transactions on a card. Transactions within the specified date range along with the balance of the card is fetched and sent to the client.

Environment: https://domain/mob1/api/onboarding/v1/statementInquiry

HTTP Method: POST

📘

Note:

The domain will be shared once this move to respective environment.

Request parameters

Header

ParameterDescriptionExample
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 Prepaid2000
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., 100100
secureCode
mandatory
String Uniquely identifies the client on payload level for performing operations.AfYtlO5kqdySIjXyNmGg3F

Body

AttributeDescriptionExample
token
mandatory
String Token is the Encrypted body of the below request AES-192-CBC bits Encryption 
messageCode
mandatory
Numeric Code to identify load card request type. Character Limit - 41080
clientTxnId
mandatory
String Unique ID generated by the client for each transaction.
Character Limit - 14
GOUd789hhhjfscs
requestDateTime
mandatory
NumericLocal Date and time stamp when the transaction originated from the client in YYYYMMDDHHMMSS with time in 24 hr format.
Character Limit - 14
20161031214559
customerId
mandatory
String Customer Id (entityCIF), which uniquely identifies the cardholder in the client system. It is conditional with mobile number and URN, i.e., either one of them should be present.
Character Limit - 20
11001188721
fromDate
optional
StringStatement Details from Date(DD/MM/YYYY) .Character Limit - 1010/10/2015
toDate
optional
StringStatement Details from Date(DD/MM/YYYY) .Character Limit - 1007/08/2016
last4Digits
mandatory
StringLast 4 digits of the card number
Character Limit - 4`
1234
urn
mandatory
String A unique reference number for the generated card. Need to share this in request body of the APIs. Conditional with mobile number and Customer Id i.e either one of them should be present.
Character Limit - 11
70000000008
pageNumber
optional
Numeric Page number indexed from 1. Character Limit - 5001
Count
optional
Numeric Max count should be 100.
Character Limit - 5
10
fromRowId
optional
StringTo counter change in the search set, key to identify the last record for the previous set. Character Limit - 100

Sample request

Packet sample (Encrypted)

{ “token”:"Pl8F5kDZcvADIiursiAvvbHNuL9Wv5eaFdorGVFU6FKfIEnV/YskkzJlAov2ZHJWnqGNLOXfB q4SQqw8Ep4sK0gCAAkRXATCb1nSY6s="
}

Packet sample (Decypted)

{
"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 Encryption Pl8F5kDZcvADIiursiA
vvbHNuL9Wv5eaFdorGV
FU6FKfIEnV/YskkzJlA
ov2ZHJWnqGNLOXfBq4S
Qqw8Ep4sK0gCAAkRXATC
b1nSY6s=

Decypted

messageCodeMessage code for statement inquiry response1073
clientIdValue copied from the request2000
clientTxnIdValue copied from the request20150701235959xhs
tiesqfds
bankIdValue copied from the request7000
UrnA unique reference number for the card(urn)70000000008
customerIdCustomer Id(entityCIF), which uniquely identifies the cardholder in the client system.IN2016201611
responseCodeContains the status of the transaction. 00 indicates success. Please refer Appendix for other response codes0
responseMessageResponse message based on response code will be sent 
DescriptionReserved field to send information to client 
availableBalanceCard available balance (implied decimals)19000
openingBalanceCard opening balance (implied decimals)19000
closingBalanceCard closing balance (implied decimals)19000
availableCashLimitAvailable Cash Limit on the card (implied decimals)110000
pageNumberPage number indexed from 11
CountCount of records returned50
statementDetails.merchantNameMerchant at which the transaction took placeAmazon Web Store
statementDetails.transactionType1.CR (Credit) 2.DR (Debit)CR
statementDetails.transactionAmountAmount of the transaction. Value will be in implied decimals10000
statementDetails.transactionDateDate of the transaction in the format YYYY-MM-DD hh:mm:ss.S2017-02-06 14:26:35
statementDetails.transactionNarrationUsed to store the clientTRNDescription for the request.PG Load
statementDetails.transactionClosingBalanceClosing balance at the end of each transaction. Value will be in implied decimals10000
statementDetails.merchantCityCityBangalore
statementDetails.transRefNumberReference Number2016XYZ123
statementDetails.rowIdRow Id to identify each row20161061214556
statementDetails.eventIdevent id’s denotes the activity303003
statementDetails.stanSYSTEM_TRACE_AUDIT_NUMBER19078
statementDetails.rrnRetrieval Reference Number634405019078
statementDetails.approvalCodeApproval Code9RQENE
statementDetails.isMerchantTxnCheck for Merchant transaction0/1 cmsEvents – 0, auth/settl – 1
statementDetails.clientTxnIdclientTxnId for cms events20150701235959xh
stiesqfds
statementDetails.statusStatement status check. Kindly refer transaction Status tag at the top section for more details0
statementDetails.authEpfTxnIdReference Number for Auth for corresponding settlement transactions5616546
statementDetails.authDateauth Date for settlement transactions. Format – YYYY-MM-DD hh:mm:ss.S2017-02-06 14:26:35
StatementDetails.subWalletIdSubwallet id of the Subwallet involved in the transactionMOB850a5597_3
StatementDetails.subWalletNameName of the Subwallet involved in the transactionMGL FUEL WALLET

API error code

Error CodeDescription
00SUCCESS
1030INVALID_MESSAGE
1083URN AND LAST 4 DIGITS MISMATCH
1088INVALID_DATE_FORMAT
1231DATA_NOT_FOUND
1237DUPLICATE_MOBILE_NUMBER_WITH_MULTIPLE_ACCOUNT
1500SYSTEM_ERROR_UNKNOWN
1501SYSTEM_ERROR

HTTP status code

HTTP Status CodeHTTP Status Description
200OK
404Not Found
500Internal Server Error
403Forbidden
400Bad Request
401Unauthorized
503Service Unavailable

Sample request

Packet sample (Encrypted)

{
      “token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”
} 

Packet sample (Decrypted)

{
"urn": 70000000182,
"responseCode": "00",
"messageCode": 1073,
"clientTxnId": "Inq_Sam_cATRriram05", "clientId": "2000",
"responseMessage": "SUCCESS", "bankId": 7000, "availableBalance": "1500", "availableCashLimit": "0", "pageNumber": 1,
"count": 100, "openingBalance": "0", "closingBalance": "1500",
"statementDetails": [ {
"merchantName": "Card Unload", "transactionType": "Debit", "transactionAmount": "1500", "transactionDate": "2023-08-04 14:18:50.550", "merchantCity": "",
"transRefNumber": "", "reserved1": "", "reserved2": "", "reserved4": "O|70000", "eventId": 303014, "rowId": 1691138930550, "authEpfTxnId": "41437", "rrn": "",
"stan": "", "approvalCode": "", "isMerchantTxn": 0, "clientTxnId": "Test2141", "status": "", "closingBalance": 1500, "openningBalance": 3000,
"transactionNarration": "" },
{
"merchantName": "Card Recharge", "transactionType": "Credit", "transactionAmount": "2000", "transactionDate": "2023-08-04 13:56:35.677", "merchantCity": "",
"transRefNumber": "", "reserved1": "", "reserved2": "", "reserved4": "I|70130", "eventId": 303003, "rowId": 1691137595677, "authEpfTxnId": "41436", "rrn": "",
"stan": "",
"approvalCode": "",
"isMerchantTxn": 0,
"clientTxnId": "Reload_VIZamPNmR9", "status": "",
"closingBalance": 3000, "openningBalance": 1000,
"transactionNarration": "" },
{
"merchantName": "Card Recharge", "transactionType": "Credit", "transactionAmount": "1000", "transactionDate": "2023-08-04 13:19:43.533",
"merchantCity": "", "transRefNumber": "", "reserved1": "", "reserved2": "", "reserved4": "I|70130", "eventId": 303003, "rowId": 1691135383533, "authEpfTxnId": "41435",
"rrn": "",
"stan": "",
"approvalCode": "",
"isMerchantTxn": 0,
"clientTxnId": "Reload_V3IZamPNmR69", "status": "",
"closingBalance": 1000, "openningBalance": 0, "transactionNarration": ""
} ]
}