GET
/
customers
/
{customer_id}
/
instruments

Authorizations

x-client-id
string
headerrequired

Client app ID. You can find your app id in the Merchant Dashboard.

x-client-secret
string
headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

x-api-version
string
default: 2023-08-01required

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
customer_id
string

customer_id for which the instrument was saved

afa_reference
string

cf_payment_id of the successful transaction done while saving instrument

instrument_id
string

saved instrument id

instrument_type
enum<string>

Type of the saved instrument

Available options:
card
instrument_uid
string

Unique id for the saved instrument

instrument_display
string

masked card number displayed to the customer

instrument_status
enum<string>

Status of the saved instrument.

Available options:
ACTIVE,
INACTIVE
created_at
string

Timestamp at which instrument was saved.

instrument_meta
object

Card instrument meta information