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
<WalletHeader />
Body
Attribute | Description | Example |
|---|---|---|
token mandatory |
|
|
messageCode |
| 1080 |
clientTxnId |
| GOUd789hhhjfscs |
requestDateTime |
| 20161031214559 |
customerId |
| 11001188721 |
fromDate |
| 10/10/2015 |
toDate |
| 07/08/2016 |
last4Digits |
| 1234 |
urn |
| 70000000008 |
pageNumber |
| 1 |
Count |
| 10 |
fromRowId |
| 0 |
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
Parameter | Description | Sample Value |
|---|---|---|
Encypted | ||
token | Token is the Encrypted body of the below request AES-192-CBC bits Encryption | Pl8F5kDZcvADIiursiA |
Decypted | ||
messageCode | Message code for statement inquiry response | 1073 |
clientId | Value copied from the request | 2000 |
clientTxnId | Value copied from the request | 20150701235959xhs |
bankId | Value copied from the request | 7000 |
Urn | A unique reference number for the card(urn) | 70000000008 |
customerId | Customer Id(entityCIF), which uniquely identifies the cardholder in the client system. | IN2016201611 |
responseCode | Contains the status of the transaction. 00 indicates success. Please refer Appendix for other response codes | 0 |
responseMessage | Response message based on response code will be sent |
|
Description | Reserved field to send information to client |
|
availableBalance | Card available balance (implied decimals) | 19000 |
openingBalance | Card opening balance (implied decimals) | 19000 |
closingBalance | Card closing balance (implied decimals) | 19000 |
availableCashLimit | Available Cash Limit on the card (implied decimals) | 110000 |
pageNumber | Page number indexed from 1 | 1 |
Count | Count of records returned | 50 |
statementDetails.merchantName | Merchant at which the transaction took place | Amazon Web Store |
statementDetails.transactionType | 1.CR (Credit) 2.DR (Debit) | CR |
statementDetails.transactionAmount | Amount of the transaction. Value will be in implied decimals | 10000 |
statementDetails.transactionDate | Date of the transaction in the format YYYY-MM-DD hh:mm:ss.S | 2017-02-06 14:26:35 |
statementDetails.transactionNarration | Used to store the clientTRNDescription for the request. | PG Load |
statementDetails.transactionClosingBalance | Closing balance at the end of each transaction. Value will be in implied decimals | 10000 |
statementDetails.merchantCity | City | Bangalore |
statementDetails.transRefNumber | Reference Number | 2016XYZ123 |
statementDetails.rowId | Row Id to identify each row | 20161061214556 |
statementDetails.eventId | event id’s denotes the activity | 303003 |
statementDetails.stan | SYSTEM_TRACE_AUDIT_NUMBER | 19078 |
statementDetails.rrn | Retrieval Reference Number | 634405019078 |
statementDetails.approvalCode | Approval Code | 9RQENE |
statementDetails.isMerchantTxn | Check for Merchant transaction | 0/1 cmsEvents – 0, auth/settl – 1 |
statementDetails.clientTxnId | clientTxnId for cms events | 20150701235959xh |
statementDetails.status | Statement status check. Kindly refer transaction Status tag at the top section for more details | 0 |
statementDetails.authEpfTxnId | Reference Number for Auth for corresponding settlement transactions | 5616546 |
statementDetails.authDate | auth Date for settlement transactions. Format – YYYY-MM-DD hh:mm:ss.S | 2017-02-06 14:26:35 |
StatementDetails.subWalletId | Subwallet id of the Subwallet involved in the transaction | MOB850a5597_3 |
StatementDetails.subWalletName | Name of the Subwallet involved in the transaction | MGL FUEL WALLET |
API error code
| Error Code | Description |
|---|---|
| 00 | SUCCESS |
| 1030 | INVALID_MESSAGE |
| 1083 | URN AND LAST 4 DIGITS MISMATCH |
| 1088 | INVALID_DATE_FORMAT |
| 1231 | DATA_NOT_FOUND |
| 1237 | DUPLICATE_MOBILE_NUMBER_WITH_MULTIPLE_ACCOUNT |
| 1500 | SYSTEM_ERROR_UNKNOWN |
| 1501 | SYSTEM_ERROR |
HTTP status code
| HTTP Status Code | HTTP Status Description |
|---|---|
| 200 | OK |
| 404 | Not Found |
| 500 | Internal Server Error |
| 403 | Forbidden |
| 400 | Bad Request |
| 401 | Unauthorized |
| 503 | Service 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": ""
} ]
}