Docs
Management API
Stored Instruments

Stored Instruments

Get Stored Instruments

GET /customers/{customerId}/stored-instruments

Request

Lists all available stored instruments for a customer. This list will include all types of stored instruments namely card, account and bank_account instruments

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • customerId in path - integer
    required

    The ID of the customer.

example

Response

OK

Body

array | application/json
One of:
  • type
    string

    Type of instrument.

    Allowed: stored_card

  • token
    string

    An identifier representing this stored instrument.

    Example: 84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c

  • is_default
    boolean

    Identifies whether this stored instrument is default for the customer.

  • brand
    string

    Card brand.

    Example: VISA

  • expiry_month
    integer

    Expiry month for this card.

    Min: 1
    Max: 12
  • expiry_year
    integer

    Expiry year for this card.

  • issuer_identification_number
    string

    Issuer identification number for this card.

    Example: 411111

  • last_4
    string

    Last four digits of this card.

    Example: 1111

  • billing_address
    object

example-1

Did you find what you were looking for?