v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Card types

Get a collection of cards

Get all cards belonging to a specific card type. Use filters such as customer_id and is_valid to narrow results. See Cards for details.

get/card-types/{card_type_id}/cards

Path parameters

card_type_idstring required

The unique ID of the card type.

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

customer_idstring

The unique ID of the customer. GET /customers

is_validtrue | false

in validity range - true / before or after validity range - false / no value - all

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

Example response

{
  "data": {
    "cards": [
      {
        "card_id": "81eaeea13b8984a169c490a325",
        "customer_id": "8ea2591121e636086a4a9c0992",
        "card_type_id": "8bed991c68a470e7aaeffbf048",
        "card_number": "1000000000016",
        "secondary_card_number": "AXNFUAIOHFDSNKA",
        "valid_from": "2021-04-14 00:00:00",
        "valid_to": "2059-07-05 00:00:00",
        "last_change": "2019-07-15 17:26:34",
        "state": 1
      }
    ],
    "total_items": 1
  }
}