v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Cards

List all cards

This allows you to request a list of all cards without having to specify a relating customer. However, you do have the ability to filter using the customer_id parameter.

get/cards

Query parameters

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

filterstring

Filter the parameters that you want to return within the response.

customer_idstring uuid

Filter results to cards stored against a specific customer_id.

Response

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "card": {
        "holder_name": "E Johnson",
        "scheme": "visa",
        "number": "8710",
        "expiry_month": 10,
        "expiry_year": 30
      },
      "bin": {
        "number": "424242",
        "type": "debit",
        "product": "consumer",
        "card_level": "standard",
        "issuer": "acquired.com",
        "issuer_country": "united kingdom",
        "issuer_country_code": "gb"
      },
      "source": "card",
      "is_active": true
    }
  ]
}