GET
/
customers
/
{customer_id}
/
instruments
Fetch All Saved Card Instrument
curl --request GET \
  --url https://sandbox.cashfree.com/pg/customers/{customer_id}/instruments \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
[
  {
    "customer_id": "siddhesh_desai",
    "afa_reference": "740324562",
    "instrument_id": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10",
    "instrument_type": "card",
    "instrument_uid": "0d8f70838cc5af8b1cd2bc0fe71278551fd3f1101e40020d89ad22ceba4f933c",
    "instrument_display": "xxxxxxxxxxxx4375",
    "instrument_status": "ACTIVE",
    "created_at": "2021-11-11 16:57:57",
    "instrument_meta": {
      "card_network": "VISA",
      "card_bank_name": "HDFC Bank Limited",
      "card_country": "IN",
      "card_type": "DEBIT_CARD",
      "card_token_details": {
        "par": "somepar",
        "expiry_month": "12",
        "expiry_year": "23"
      }
    }
  }
]

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app id in the merchant dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret in the merchant dashboard.

Headers

​
x-api-version
string
default:2025-01-01
required

API version to be used. Format is in YYYY-MM-DD.

​
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

​
x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Path Parameters

​
customer_id
string
required

Your Customer ID that you had sent during create order API POST/orders.

Query Parameters

​
instrument_type
enum<string>
required

Payment mode or type of saved instrument

Available options:
card

Response

200
application/json

OK

The response is of type InstrumentEntity · object[].