The Card Inquiry API is called by the client to retrieve the summary of the card. e.g. Cardholder information, balance on the card etc. This API will not provide the transaction history of the card.
Environment: https://domain/mob1/API/onboarding/v1/cardInquiry
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 |
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": "1090",
"clientTxnId": "20200804162237767_Aero_Wibmo_B12dscxdD",
"last4Digits": "6974",
"urn": 70000000008,
"customerId": "129915",
"requestDateTime": "20200804162237"
}
Response parameters
| Parameter | Description | Example |
|---|---|---|
| ||
| token | Token is the Encrypted body of the below request AES-192-CBC bits Encryption | Pl8F5kDZcvADIiursiAvvb HNuL9Wv5eaFdorGVFU 6FKfIEnV/YskkzJlAov2ZHJ WnqGNLOXfBq4SQqw8Ep 4sK0gCAAkRXATCb1nSY6s= |
| ||
| messageCode | Code to Identity “Card Inquiry” API response | 1091 |
| clientTxnId | Unique Id generated by the client for each transaction. This value must be unique for every API call | 20150701235959xhstiesqfds |
| responseDateTime | Response date time in the format YYYYMMDDHHMMSS with time in 24 hr format | 20161031214559 |
| responseCode | Contains the status of the transaction. 00 indicates success. Please refer Appendix for other response codes | 00 |
| responseMessage | Response message based on response code will be sent | “SUCCESS” |
| urn | A unique reference number for the generated card/wallet by Prepaid system | 70000000008 |
| bankId | Value copied from header | 7000 |
| clientId | Value copied from header | 2000 |
| description | Reserved field to send information to client | |
| availableBalance | Wallet available balance (implied decimals) | 50,000 |
| availableCashLimit | Available Cash Limit on the card (implied decimals) | 11,000 |
| cardNumber | Full Card Number | 47994XXXX1156979 |
| cardExpiry | Expiry of the card in format MMYY | 07XX |
| cardCVV2 | CVV for the card | 6XX |
| cardProfileId | Profile id of the card | 30 |
| activationTimeStamp | Activation date time of the card | 01:12.0 |
| lastActivityTimeStamp | Last Activity date time of the card | 01:12.0 |
| cardHolderFistName | Card holder first name | Alice |
| cardHolderLastName | Card holder last name | John |
| cardholderMobile | Mobile number of the card holder. Please append 60 at the beginning of this field. | 6.0014E+11 |
| cardholderEmail | Email address of the card holder | [email protected] |
| cardholderAddress | address of the card holder | 212 One way drive, Seattle |
| cardholderCity | City of the cardholder | Bangalore |
| cardholderState | State of the cardholder | Karnataka |
| cardholderCountry | Country of the cardholder | India |
| cardholderZipCode | ZipCode of the cardholder | 560020 |
| cardHolderDateOfBirth | Date of birth of the cardholder. Format is dd-MMM-yyyy | 25-Dec-90 |
| SubwalletDetails. subwallet_id | Subwallet id of the subwallet | Mob497d9a_1 |
| SubwalletDetails. default_wallet | Whether this subwallet is default subwallet or not | 0/1 |
| SubwalletDetails. available_balance | Total available balance of the subwallet | 20,000 |
| SubwalletDetails. account_number | Account number of the subwallet | 6.0501E+12 |
| SubwalletDetails. account_status | Account status of the subwallet | 9 – pre-active 0 – Active 21 - Disabled |
| SubwalletDetails. subwallet_name | Subwallet name of the subwallet | “Mobility gpr wallet” |
| SubwalletDetails. ledger_balance | Ledger balance linked to the subwallet | 10000 |
| SubwalletDetails. authorized_amount | Total authorized amount linked to subwallet that has been deducted after authorization | 10000 |
| SubwalletDetails. settled_amount | Total settled amount linked to subwallet that has been settled after transaction | 10000 |
| SubwalletDetails. jitAuthorized_amount | Total authorized amount linked to subwallet that has been deducted after JIT transaction | 10000 |
| SubwalletDetails. jitSettled_amount | Total settled amount linked to subwallet that has been settled after JIT transaction | 10000 |
API error codes
| Error Code | Description |
|---|---|
| 0 | SUCCESS |
| 1001 | CARD_NOT_FOUND |
| 1030 | INVALID MESSAGE |
| 1031 | INVALID BANK ID |
| 1032 | INVALID_CLIENT_CHANNEL |
| 1049 | INVALID SECURE CODE |
| 1052 | SYSTEM_ERROR |
| 1055 | MALFORMED_REQUEST |
| 1081 | OPERATION NOT ALLOWED |
| 1083 | URN AND LAST 4 DIGITS MISMATCH |
| 1084 | URN AND CUSTOMER ID MISMATCH |
| 1088 | INVALID DATE FORMAT |
| 1093 | INVALID CLIENT TXN ID |
| 1262 | CLIENT ID NOT PRESENT |
| 1264 | BANK ID NOT PRESENT |
| 1310 | XCONSUMERKEY NOT PRESENT |
| 1311 | SECURE CODE NOT PRESENT |
| 1320 | REQUEST_DATETIME_IS_MANDATORY |
| 1500 | SYSTEM ERROR |
HTTP status code
| HTTP Status Code | HTTP Status Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Internal Server Error |
| 403 | Forbidden |
| 404 | Not Found |
| 503 | Service Unavailable |
Sample response
Packet sample (Encrypted)
{
“token”: “h/0YSUdGzgNsMcmfYAvIIPgF3Z80/kMJkW/7l9wG9L+bXt//P/HBG0NsuoPtbn6ugjzNOLl/wQPJFbCKMqQJtSSQs4JVYBohia1TPP1yJULHN+TLIVKFRZsg0GokTPI+ZKpNPcrKrQSa70qV/RtVWMv6CmqRHaG1gQvgAYKjNyOpip7G3Io5IDEF4b2cXOlH4G1hbOtjAHQ/7ZS9KrkmJA==”}
Packet sample (Decrypted)
Success scenario
{
"urn": 70000000008,
"customerId": "62509sree0001",
"description": "Active",
"responseCode": "00",
"messageCode": 1091,
"clientTxnId": "CardINq_JMquSQD5WucX=mob234222227",
"clientId": "2000",
"responseDateTime": "20230605182552",
"responseMessage": "SUCCESS",
"bankId": 7000,
"cardNumber": "8000XXXXX9405293",
"cardExpiry": "0X25",
"cardCVV2": "2X4",
"cardStatus": "0",
"availableBalance": "90000",
"availableCashLimit": "0",
"subwalletListDetails": [
{
"subwallet_id": "Mob497d9a_1",
"default_wallet": 1,
"available_balance": "900.00",
"account_number": "601010002488",
"account_status": "0",
"subwallet_name": "utility Wallet",
"ledger_balance": "900.00",
"authorized_amount": "0.00",
"settled_amount": "0.00"
},
{
"subwallet_id": "Mob497d9a_2",
"default_wallet": 0,
"available_balance": "0.00",
"account_number": "601010002496",
"account_status": "0",
"subwallet_name": "General Purpose wallet",
"ledger_balance": "0.00",
"authorized_amount": "0.00",
"settled_amount": "0.00"
}
],
"cardHolder": {
"cardProfileId": 300,
"cardholderFirstName": "Sandeep",
"cardholderLastName": "Prasad",
"cardholderMobile": "600140016908",
"cardholderEmail": "[email protected]",
"cardholderAddress": "MGRaod, India ",
"cardholderCity": "Bangalore",
"cardholderState": "Karnataka",
"cardholderCountry": "India",
"cardholderZipCode": "560022",
"cardholderDateOfBirth": "11-Jul-1995",
"cardholderAddressLine1": "#3,dasMeena Nilayat",
"cardholderAddressLine2": "2nd ddCrosss, Tejewswini agar",
"cardholderAddressLine3": "Near Meenakshi Temple ",
"employeeId": "",
"ovdName": "",
"isPanValid": 0
},
"activationTimeStamp": "2023-06-01 13:47:11.826",
"lastActivityTimeStamp": "2023-06-02 15:38:12.871"
}
Failure scenario
{
"responseCode": "1001",
"responseDateTime": "20220914200827",
"responseMessage": "CARD NOT FOUND"
}