Get Instruments

Use this API to get the details of multiple cards or instruments issued to your customer.

Click to view the response codes.

Response Codes

Sub CodeStatusMessageAction
200OK--
403ERRORfailed to authenticateEnsure the client ID, secret key, and API version are mentioned in the API.
404ERRORcustomer with given id not foundEnter a valid input in the customer_id parameter.
Click to view the response parameters and its descriptions.

Response Parameters

ParameterDescription
instrument_idIt represents the unique ID entered to identify the prepaid payment instrument(PPI) card.
customer_idIt represents the unique ID entered to identify the customer.
instrument_typeIt represents the type of the instrument. It is a hardcoded value - PREPAID_CARD.
remarksIt represents any remarks added.
modeIt represents the mode of the instrument - digital or physical card.
issuerIt represents the name card issuer.
networkIt represents the network of the issued card or instrument.
prepaid_card_statusIt represents the status of the issued card or instrument. The different statuses are - FAILED, PENDING, ACTIVE, INACTIVE, REJECTED, BLOCKED.
prepaid_card_sub_statusIt represents the reason for the prepaid_card_status parameter.
last_4_digitsIt represents the last 4 digits of the prepaid card instrument.
kit_numberIt represents the kit number of the prepaid card.
verification_statusIt represents the status of the KYC document verification.
verification_sub_statusIt represents the reasons for the verification_status parameter.
expiryIt represents the expiry date of the prepaid card instrument.
added_onIt represents the date of the entry creation date.
cursorIt represents the value that can be used for pagination in the same API.
has_moreThe value true represents that the customer has more instruments.

The value false represents that the customer does not have any more instruments.

Language