List stored cards
List Stored Cards API which lists all the cards stored for a given customer. This API gives back only tokens and associated metadata details (such as card type, masked card number, expiry date, and card token, card reference, card bin) relevant to the cards stored in Juspay Locker.
This API allows merchants to display securely stored card details for a seamless and convenient payment experience during checkout.
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive.
Passing this value will help us route efficiently at network level.
Example:- x-merchantid: testaccount
Customer ID which represents the user uniquely. Eithercustomer_id or object_reference_id can be used to retrieve stored card details.
Object_reference_id: An ID maintained at merchant’s end for each customer.Customer_id: An ID(idfield of Create customer API response) created by Juspay for eachObject_reference_idduring the Create Customer API call.
Customer Id given in the request
Merchant id associated with Juspay
Array of stored cards that belongs to the given user represented by the Customer ID. Each member of the array is an associative array that represents a stored card of the user.
Token representing the card. Payment has to be initiated using this token. Tokens are by definition short lived and so, please do not cache them in your system. Expired tokens will lead to transactions being declined.
A reference identifier that doesn’t change for the stored card. Use this identifier to store any metadata that you wish. For example, you can store card type or card bin or even transaction data using this reference
A 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.
Masked card number that can be displayed to the customer.
First 6 digits of the card
Year of expiry of the card
Month of expiry of the card
Indicates if the card is either CREDIT or DEBIT. Please note that this information is inferred. Not all cards will have this information.
Indicates 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.
Indicates the name of the card switch provider.Please note that this information is inferred
Cardholder name given while storing the card
Returns the given nickname while storing the card
Indicates whether the stored card is expired or not
Indicates if the tokenised card is eligible for cvv-less payments. Merchants can stop collecting the CVV value for eligible tokens.
List of gateways which are available for cvv-less token transactions. Juspay's dynamic routing will be applied among these gateways. Alternatively, a Gateway ID pertaining to one of the listed gateways can be passed in Create Order API to force route the transaction.
Specifies the status of API response
Example:- Value: error
Denotes the error code of the failure
Example:- access_denied
Additional information on the error
Category of the error
Example:- Sample Value: USER_ERROR
Detailed information on the error
Example:- Sample Value: Invalid API Key. Please pass a valid and active api key.
Error message which can be displayed to the user
Example:- Sample Value: Unauthorized.