Card Inquiry API

The **Card Inquiry **API is ued to retrieve the details of the card including card holder information, card details, balance on the card, etc.

đŸ“˜

Note:

The **Card Inquiry **API will not provide the transaction history of the card.

Sandboxpayusandbox-kong.pc.enstage-sas.com/api/onboarding/v3/statementInquiry
ProductionContact your WIBMO KAM or support.
Sample request
curl --request POST \
     --url https://payusandbox-kong.pc.enstage-sas.com/uat/sbx/api/onboarding/v3/statementInquiry \
     --header 'X-Consumer-Custom-ID: F42BC4E7B801C834B630DE498473533F' \
     --header 'bankId: 6060' \
     --header 'clientId: 1060' \
     --header 'content-type: application/json' \
     --header 'entityId: 100' \
     --header 'secureCode: pu8gSMLNE7pNv36IlUmstU' \
     --header 'x-api-key: 4A02C4267C9A97A1488AB3259FD1A725' \
     --data '
{
  "token": "PvLNIjKAREzAVW6+GKpbcmtepBQ5LfPNuRoVWhf0oyBaFYFDSCY9LxfrGa39nj7Ff0wnoj4L31uFU2kXrc/WSeTuURE4CGm4Lgzl61DHQLQQ8n4Gcm25YE8UQaHBJsQwugGMWUmIw3yrtRpKS1b0z679bLT1wtaFjF2TvUbXfI0e/0AGd/4WvbvcDChXQ6LUIFC80mxjinbTp6V4CYgIxCP0O7zaZYJ8I1nput5ZiV9WbWHR9CroIWe7Cs108Y2jD+mbyUAXKP4C3IqySZCQqNVqrf9ev6GWNZvx5aN9Af5Rlh+wh7VFyvvNXZGd/SrdDUDCPNIjAvLYlwVkunKovsnnl+wVNBIcVkB06O/K9JfBoJIl3u2BhbRwCg7MD89s"
}
'
Response parameters (Decrypted)

This API will provide a token in the response that must be decrypted using the Decrypt API. The decrypted response is similar to the following:

Parameter Type Parameter Requirement Description

messageCode

numeric(4)

Mandatory

Code to Identify "Card Inquiry" API response

clientTxnId

string(100)

Mandatory

Echoed from the request.

urn

numeric(11)

Mandatory

Echoed from the request.

availableBalance

numeric(12)

Mandatory

Wallet available balance (implied decimals)

availableCashLimit

Numeric(12)

Mandatory

Available Cash Limit on the card (implied decimals)

cardStatus

Numeric(3)

Mandatory

Status of the card.

0-Active

cardNumber

String(20)

Mandatory

Card number

cardExpiry

String(100)

Mandatory

Expiry of the card in format MMYY

cardCVV2

String(100)

Mandatory

CVV for the card

cardholder.cardProfileId

numeric(2)

Mandatory

Profile id of the card

activationTimeStamp

String(50)

Optional

Activation date time of the card

lastActivityTimeStamp

String(50)

Optional

Last Activity date time of the card

cardholder.cardHolderFistName

String(50)

Mandatory

Cardholder first name

cardholder.cardHolderLastName

String(50)

Mandatory

Cardholder last name

cardholder.cardholderMobile

Numeric(13)

Optional

Mobile number of the Cardholder.

cardholder.cardholderEmail

String(50)

Optional

Email address of the Cardholder

cardholder.cardholderAddress

String(500)

Optional

address of the Cardholder

cardholder.cardholderCity

string(100)

Optional

City of the cardholder

cardholder.cardholderState

String(100)

Optional

State of the cardholder

cardholder.cardholderCountry

string(50)

Optional

Country of the cardholder

cardholder.cardholderZipCode

string(6)

Optional

PIN code or Zip code of the cardholder

cardholder.cardHolderDateOfBirth

String(50)

Optional

Date of birth of the cardholder. Format is dd-MMM-yyyy

subwalletDetails.subwallet_id

String

Mandatory

Subwallet id of the subwallet

subwalletDetails.default_wallet

String

Mandatory

Whether this subwallet is default subwallet or not

subwalletDetails.available_balance

String

Mandatory

Total available balance of the subwallet

subwalletDetails.account_number

String

Mandatory

Account number of the subwallet

subwalletDetails.account_status

String

Mandatory

Account status of the subwallet

subwalletDetails.subwallet_name

String

Mandatory

Subwallet name of the subwallet

subwalletDetails.ledger_balance

String

Mandatory

Ledger balance linked to the subwallet

subwalletDetails.authorized_amount

String

Mandatory

Total authorized amount linked to subwallet that has been deducted after authorization

subwalletDetails.settled_amount

String

Mandatory

Total settled amount linked to subwallet that has been settled after transaction

subwalletDetails.jitAuthorized_amount

String

Optional

Total authorized amount linked to subwallet that has been deducted after the JIT transaction

subwalletDetails.jitSettled_amount

String

Optional

Total settled amount linked to subwallet that has been settled after JIT transaction.

Sample response (Decrypted)
{
    "urn": 70000000995,
    "customerId": "000000000148",
    "description": "Active",
    "responseCode": "00",
    "messageCode": 1091,
    "clientTxnId": "CardINq_JMquSQD511",
    "clientId": "1040",
    "responseDateTime": "20231207093155",
    "responseMessage": "SUCCESS",
    "bankId": 6010,
    "cardNumber": "4064764329222158",
    "cardExpiry": "1225",
    "cardCVV2": "565",
    "cardStatus": "0",
    "availableBalance": "0",
    "availableCashLimit": "0",
    "subwalletListDetails": [
        {
            "subwallet_id": "XOX850a5597_1",
            "default_wallet": 1,
            "available_balance": "0.00",
            "account_number": "601XXXXXXX612",
            "account_status": "0",
            "subwallet_name": "MetroWallet",
            "ledger_balance": "0.00",
            "authorized_amount": "0.00",
            "settled_amount": "0.00"
        },
        {
            "subwallet_id": "XOX850a5597_2",
            "default_wallet": 0,
            "available_balance": "0.00",
            "account_number": "601XXXXXXX620",
            "account_status": "9",
            "subwallet_name": "Xoxo Pharmacy Wallet",
            "ledger_balance": "0.00",
            "authorized_amount": "0.00",
            "settled_amount": "0.00"
        },
        {
            "subwallet_id": "XOX850a5597_3",
            "default_wallet": 0,
            "available_balance": "0.00",
            "account_number": "601XXXXXXX38",
            "account_status": "9",
            "subwallet_name": "Xoxo Fuel Wallet",
            "ledger_balance": "0.00",
            "authorized_amount": "0.00",
            "settled_amount": "0.00"
        }
    ],
    "cardHolder": {
        "cardProfileId": 150,
        "cardholderFirstName": "Test",
        "cardholderLastName": "Test",
        "cardholderMobile": "9191XXXXXX",
        "cardholderEmail": "[email protected]",
        "cardholderCity": "NewYork",
        "cardholderState": "NY",
        "cardholderCountry": "USA",
        "cardholderZipCode": "10001",
        "cardholderDateOfBirth": "06-Jan-2000",
        "isPanValid": 0,
        "ovdType": 0
    },
    "activationTimeStamp": "2023-12-06 16:00:15.343693",
    "lastActivityTimeStamp": "2023-12-06 16:00:15.343693"
}
Error codes (Decrypted)
 Error CodeDescription
00SUCCESS
1001CARD_NOT_FOUND
1030INVALID MESSAGE COD
1031INVALID BANK ID
1032INVALID_CLIENT_CHANNEL
1049INVALID SECURE CODE
1052SYSTEM_ERROR
1055MALFORMED_REQUEST
1056INVALID MESSAGE CODE
1081OPERATION NOT ALLOWED
1083URN AND LAST 4 DIGITS MISMATCH
1084URN AND CUSTOMER ID MISMATCH
1085REQUESTOR UNAUTHORIZED FOR URN OR PRODUCT
1088INVALID DATE format
1093INVALID CLIENT TXN ID
1116CARD AML PROFILE MISSING
1262CLIENT ID NOT PRESENT
1264BANK ID NOT PRESENT
1310XCONSUMERKEY NOT PRESENT
1311SECURE CODE NOT PRESENT
1320REQUEST_DATETIME_IS_MANDATORY
1346URN_IS_MANDATORY
1500SYSTEM ERROR
1501SYSTEM ERROR(DB)
5003CLIENT_NOT_CONFIGURED_UNDER_BANK_ID
9329LAST 4 DIGITS IS MANDATORY
9343CLIENT TXN ID IS MANDATORY
10108CUSTOMER ID MISSING

Request parameters

Language
URL
Click Try It! to start a request and see the response here!