Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

List stored cards

List all the cards stored for a customer. This API gives back only tokens and other metadata relevant to the cards stored in JusPay Locker. An optional request parameter allows you to check if cards are eligible for ATM PIN payments.

 Response Parameters  for the List Stored Cards API:   (click to view)
ParameterTypeDescription
customer_idwwwwwwStringCustomer Id given in the request
merchantIdStringMerchant id associated with Juspay
cards: [{...},{...},..]ArrayAn array of  Card (List) Parameters objects, with details of each card that belongs to the given user represented by the Customer ID     (see table below).
Card (List) Parameters:   Each element returned in the cards array is a  Card (List) Parameters object, which represents a stored card of the user.     (click to view)
FieldTypeDescription
card_tokenStringToken representing the card. Payment must be initiated using this token. Tokens are by definition short lived, so please do not cache them in your system. Expired tokens will lead to transactions being declined.
card_referenceStringA reference identifier that doesn’t change for the stored card. Can be used to store any card metadata; for example: card type, card bin, or even transaction data.
card_fingerprintStringA string that uniquely identifies the card across the board. When the same card is stored across multiple accounts, same fingerprint will be returned. This can be used to identify duplicates.
card_numberStringMasked card number that can be displayed to the customer.
card_isinStringFirst 6 digits of the card
(International Securities Identification Number)
card_exp_yearStringExpiry year of the card
(Format: yyyy) Example: "2020"
card_exp_monthStringExpiry month of the card
(Format: mm) Example: "06"
card_typeStringIndicates if the card is either CREDIT or DEBIT. Please note that this information is inferred. Not all cards will have this information.
card_issuerStringIndicates the bank which issued the card. This again is not available all the time. We make our best effort to get this information for all cards.
card_brandStringIndicates the name of the card switch provider (MASTERCARD, VISA, etc.). Please note that this information is inferred
name_on_cardStringCardholder name given while storing the card. Should contain alphabetical characters only.
nicknameStringOptional nickname for card
expiredBooleanIndicates whether the stored card is expired or not
atm_pin_auth_supportBooleanIndicates if the card is eligible for ATM PIN payments
The request must include a Query parameter: customer_id. The Options object contains optional Boolean variables for eligibility checks.
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!