Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Cards

ListCards

Retrieves a list of cards owned by the account making the request. A max of 25 cards will be returned.

get/v2/cards

Query parameters

cursorstring

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.

See Pagination for more information.

customer_idstring

Limit results to cards associated with the customer supplied. By default, all cards owned by the merchant are returned.

include_disabledboolean

Includes disabled cards. By default, all enabled cards owned by the merchant are returned.

reference_idstring

Limit results to cards associated with the reference_id supplied.

sort_order'DESC' | 'ASC'

The order (e.g., chronological or alphabetical) in which results from a request are returned.

Sorts the returned list by when the card was created with the specified order. This field defaults to ASC.

Response

Success

cursorstring

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

See Pagination for more information.

Example response

{
  "cards": [
    {
      "billing_address": {
        "address_line_1": "500 Electric Ave",
        "address_line_2": "Suite 600",
        "administrative_district_level_1": "NY",
        "country": "US",
        "locality": "New York",
        "postal_code": "10003"
      },
      "bin": "411111",
      "card_brand": "VISA",
      "card_type": "CREDIT",
      "cardholder_name": "Amelia Earhart",
      "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
      "enabled": true,
      "exp_month": 11,
      "exp_year": 2022,
      "fingerprint": "ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q",
      "hsa_fsa": false,
      "id": "ccof:uIbfJXhXETSP197M3GB",
      "last_4": "1111",
      "merchant_id": "6SSW7HV8K2ST5",
      "prepaid_type": "NOT_PREPAID",
      "reference_id": "user-id-1",
      "version": 1
    }
  ]
}