Skip to main content
GET
/
customers
/
{customer_id}
/
instruments
/
{instrument_id}
Fetch Specific Saved Card Instrument
curl --request GET \
  --url https://sandbox.cashfree.com/pg/customers/{customer_id}/instruments/{instrument_id} \
  --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:2022-09-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<UUID>

Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors.

Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders

Path Parameters

ā€‹
customer_id
string
required

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

ā€‹
instrument_id
string
required

The instrument_id of the saved instrument which needs to be queried

Response

OK

Saved card instrument object

ā€‹
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