JavaScript is disabled. Some features may not work. You can also read the static version: View text version

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.

Supported networks - Visa supports cvv-less token transactions across issuers. (Available in sandbox)
Mastercard supports cvv-less token transactions for limited 20 issuers. (To be made available by May 07, 2023)

Supported gateways -

Paytm V2
Cybersource
Payu
Razorpay

Supported banks for Mastercard

HDFC Bank
Punjab National Bank
Axis Bank
Bank Of India
Citibank
Standard Chartered Bank
SBI
Union Bank of India
RBL Bank
South Indian Bank
ICICI Bank
City Union Bank
SBM
Yes Bank
Karur Vysya Bank
IndusInd Bank
IDBI Bank
Federal Bank
Bandhan Bank

Request

Response

API Endpoints

Sandbox Link

GET

https://sandbox.juspay.in/cards

Production Link

GET

https://api.juspay.in/cards

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:-
Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      Content-Type
                      *
                      

String

Mandatory

application/x-www-form-urlencoded

                      x-merchantid
                      *
                      

String

Mandatory

Merchant ID provided by Juspay

                      x-routing-id
                      *
                      

String

Required

We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.

This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.

Example:- customer_1122

                      options. atm_pin_auth_support
                      
                      

Boolean

This is a boolean variable and accepts true/false. If set to true, then the card eligibility check for ATM PIN payments will be done.

                      options.check_cvv_less_support
                      
                      

Boolean

options.check_cvv_less_support

                      customer_id
                      *
                      

String

Mandatory

Max Length : 300

Customer ID which represents the user uniquely. This is same as the object_reference_id using which customer was created

                      options.check_mandate_support
                      
                      

Boolean

Optional

To verify if the card is supported for mandates

Response Body

                      customer_id
                      
                      

string

Max Length : 300

Customer Id given in the request

                      merchantId
                      
                      

string

Max Length : 255

Merchant id associated with Juspay

                      cards
                      
                      

Array Of Objects

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.

                      card_token
                      
                      

String

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.

                      card_reference
                      
                      

String

Max Length : 256

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

                      card_fingerprint	
                      
                      

String

Max Length : 256

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.

                      card_number
                      
                      

String

Masked card number that can be displayed to the customer.

                      card_isin
                      
                      

String

First 6 digits of the card

                      card_expiry_year
                      
                      

String

Year of expiry of the card

                      card_exp_month
                      
                      

String

Month of expiry of the card

                      card_type
                      
                      

String

Indicates if the card is either CREDIT or DEBIT. Please note that this information is inferred. Not all cards will have this information.

                      card_issuer
                      
                      

String

Max Length : 256

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.

                      card_brand
                      
                      

String

Indicates the name of the card switch provider.Please note that this information is inferred

                      name_on_card
                      
                      

String

Max Length : 256

Cardholder name given while storing the card

                      nickname
                      
                      

String

Returns the given nickname while storing the card

                      expired
                      
                      

String

Indicates whether the stored card is expired or not

                      atm_pin_auth_support	
                      
                      

String

Indicates if the card is eligible for ATM PIN payments.

                      cvv_less_support	
                      
                      

String

Indicates if the tokenised card is eligible for cvv-less payments. Merchants can stop collecting the CVV value for eligible tokens.

                      cvv_less_supported_gateways	
                      
                      

String

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.

Response Body

                      status
                      
                      

string

error

                      error_code
                      
                      

string

access_denied

API Latency Guidelines

What is API Latency?

Time taken by the server to respond to the API request.

Average API Percentile Metrics and Recommended Timeout

TP50 (ms): This represents the median latency, meaning 50% of all requests are completed in this time or less. It indicates the typical performance experienced by the majority of users.

TP90 (ms): This value shows that 90% of requests are completed within this time, leaving 10% of requests that take longer. It gives insight into the performance for a broader set of users, beyond the median.

TP99 (ms): This value indicates that 99% of requests finish within this time, with only 1% of requests taking longer. It helps identify outlier cases where latency may become an issue for a small group of users.

TP99.9 (ms): This metric captures extreme latency outliers, where only 0.1% of requests take longer than this value. It’s useful for understanding edge cases where performance degrades for very few users.

TP99.99 (ms): This measures the most rare and severe performance outliers, where just 0.01% of requests exceed this time. Monitoring this helps in addressing the rarest and most critical latency issues that may impact user experience in exceptional scenarios.

Scroll inside to view more

Transaction Percentile	Latency (ms)
TP50 (ms)	17.28
TP90 (ms)	51.57
TP99 (ms)	126.85
TP99.9 (ms)	206.42
Recommended Timeout(ms)	1000

The recommended timeouts are based on TP99.9 data, though edge cases (0.01% of requests) may still exceed these limits and are captured in the TP99.99 data as shown below.

Scroll inside to view more

Transaction Percentile	Latency (ms)
TP99.99 (ms)	488.85
Recommended Timeout(ms)	1000

Have questions?
Need help? Contact support
LLM? Read llms.txt