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

Fetch Customer's Saved Payment Methods

Overview

This API enables merchants to fetch a customer's saved payment methods, helping create a faster and smoother checkout experience.

Supported Payment Methods

Currently, we support retrieving the following saved payment methods:

Virtual Payment Addresses (VPAs)
Cards
Wallets

The response includes only supported payment methods under the saved_payment_methods section.
If a customer has saved payment methods that are not supported, they will be explicitly listed separately in the response under an unsupported_payment_methods section.

Authentication and Security

The API supports two authentication methods:

API Key (Basic Auth): Use the Authorization header with a base64-encoded API key.
Client Authentication Token (Query Parameter): Provide the client_auth_token as a query parameter.

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/customers/:customer_id/payment_methods

Production Link

POST

https://api.juspay.in/customers/:customer_id/payment_methods

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Required

Required for API key-based authentication

Example:- Eg: Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      Content-Type
                      *
                      

String

Mandatory

Specifies the content type of the request

Example:- application/json

                      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

                      client_auth_token
                      *
                      

String

Mandatory

Required for client token authentication

Example:- tkn_2424d8a02437437e896e10f3cc4ffb1a

                      order_id
                      
                      

String

Optional

Optional order ID to retrieve specific payment methods

Example:- order1737617967d

Response Body

                      UPI_COLLECT
                      
                      

Array

An array containing details of saved UPI Collect VPAs.

                      count
                      
                      

Number

Number of Saved VPA’s

                      last_used
                      
                      

String

Timestamp (ISO 8601 format) of the last time this VPA was used.

vpa

String

The Virtual Payment Address saved by the customer.

                      CARD
                      
                      

Array

An array containing details of saved card

                      card_sub_type
                      
                      

String

The subtype of the card (e.g., VISA SIGNATURE)

                      token
                      
                      

object

Contains tokenization details of the card.

                      tokenization_status
                      
                      

String

Status of the token (e.g., ACTIVE).

                      last_four_digits
                      
                      

String

Last 4 digits of the tokenized card.

                      card_reference
                      
                      

String

Reference ID for the tokenized card.

                      expiry_month
                      
                      

String

Expiry month of the card.

                      expiry_year
                      
                      

String

Expiry year of the card.

                      card_fingerprint
                      
                      

String

Unique fingerprint of the tokenized card.

                      extended_card_type
                      
                      

String

Extended classification of the card (e.g., CREDIT, DEBIT).

                      card_global_fingerprint
                      
                      

String

Global identifier for the card across merchants.

                      nickname
                      
                      

String

User-defined label for the saved card (if any).

                      provider_category
                      
                      

String

Indicates the provider classification, typically NETWORK.

                      vault_provider
                      
                      

String

Vault used to store card details (e.g., JUSPAY).

                      card_reference
                      
                      

String

Juspay's internal reference for this saved card.

                      card_type
                      
                      

String

Primary card type such as CREDIT or DEBIT.

                      metadata.origin_merchant_id
                      
                      

String

Identifier for the merchant where the card was originally saved.

                      card_brand
                      
                      

String

Brand/network of the card (e.g., VISA, MASTERCARD).

                      card_issuer
                      
                      

String

The issuing bank (e.g., Kotak Mahindra Bank).

                      card_token
                      
                      

boolean

Indicates if this card supports tokenization for network tokens.

                      card_exp_month
                      
                      

String

Expiry month of the card (e.g., 08).

                      provider
                      
                      

String

Network provider of the card (VISA, MASTERCARD, etc.).

                      expired
                      
                      

String

Indicates whether the card is expired.

                      card_fingerprint
                      
                      

String

Unique fingerprint for identifying the card securely.

                      juspay_bank_code
                      
                      

String

Juspay-specific bank identifier (e.g., JP_KOTAK).

                      card_exp_year
                      
                      

String

Expiry year of the card (e.g., 2028).

                      name_on_card
                      
                      

String

Cardholder’s name as entered during card addition.

                      country_code
                      
                      

String

ISO country code of the card (e.g., 356 for India).

                      card_number
                      
                      

String

Masked card number (e.g., XXXX-XXXXXXXX-0952).

                      card_isin
                      
                      

String

ISIN (International Securities Identification Number) for the card.

                      card_issuer_country
                      
                      

String

Country of the issuing bank (e.g., INDIA).

                      last_four_digits
                      
                      

String

Last four digits of the card for display purposes.

                      Wallet
                      
                      

Array

                      linked
                      
                      

boolean

Indicates whether the wallet is currently linked to the user account.

id

String

Unique identifier for the saved wallet payment method.

                      metadata
                      
                      

object

Contains additional information about the wallet.

                      mobile_Number
                      
                      

String

Masked mobile number associated with the wallet.

                      device_Id
                      
                      

String

Device ID from which the wallet is accessed or registered.

                      wallet
                      
                      

String

Name of the wallet provider (e.g., TATANEU).

                      gateway_reference_id
                      
                      

String

Internal or gateway-specific reference ID for the wallet.

                      last_refreshed
                      
                      

String

Timestamp indicating when the wallet data was last refreshed.

                      sub_details
                      
                      

array

Contains sub-level wallet usage and balance details.

                      last_Used
                      
                      

String

Timestamp of the last usage of the wallet.

                      current_Balance
                      
                      

null or number

Current wallet balance. null if balance is not available.

                      last_Refreshed
                      
                      

String

Timestamp when the sub-detail was last updated.

                      payment_Method
                      
                      

String

Name of the wallet payment method.

                      payment_Method_Type
                      
                      

String

Type of payment method (e.g., WALLET).