CHcheckout
Cardholders

Get a cardholder's cards

Retrieves the cards issued to the specified cardholder.

Card credentials are not returned in the response. The response is limited to a maximum of 150 cards.

get/issuing/cardholders/{cardholderId}/cards

Request

Path parameters

cardholderIdstring required

The cardholder's unique identifier.

Example:crh_d3ozhf43pcq2xbldn2g45qnb44

Query parameters

statusesstring

The card statuses to filter the results by. Cards matching any status in this list are returned. If the list is empty, all cards are returned. Format - Comma-separated list

Response

Cardholder's cards retrieved successfully

Example response

{
  "cards": [
    {
      "id": "crd_fa6psq242dcd6fdn5gifcq1491",
      "client_id": "cli_vkuhvk4vjn2edkps7dfsq6emqm",
      "entity_id": "ent_fa6psq242dcd6fdn5gifcq1491",
      "cardholder_id": "crh_d3ozhf43pcq2xbldn2g45qnb44",
      "card_product_id": "pro_7syjig3jq3mezlc3vjrdpfitl4",
      "user_id": "usr_fa6psq242dcd6fdn5gifcq1491",
      "last_four": "1234",
      "expiry_month": 5,
      "expiry_year": 2025,
      "status": "active",
      "display_name": "JOHN KENNEDY",
      "type": "virtual",
      "billing_currency": "USD",
      "issuing_country": "US",
      "reference": "X-123456-N11",
      "metadata": {
        "udf1": "metadata1",
        "udf2": "metadata2",
        "udf3": "metadata3",
        "udf4": "metadata4",
        "udf5": "metadata5"
      },
      "revocation_date": "2027-03-12T00:00:00.0000000",
      "scheduled_activation_date": "2026-06-01T10:00Z",
      "root_card_id": "crd_fa6psq242dcd6fdn5gifcq1491",
      "parent_card_id": "crd_qm26t52qz3yejjo2t4btqvxtzi",
      "scheme": "mastercard",
      "created_date": "2021-09-09T19:41:39Z",
      "last_modified_date": "2021-09-09T19:41:39Z",
      "_links": {
        "self": {
          "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491",
          "actions": [
            "GET"
          ],
          "types": [
            "application/json"
          ]
        },
        "credentials": {
          "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/credentials",
          "actions": [
            "GET"
          ],
          "types": [
            "application/json"
          ]
        },
        "revoke": {
          "href": "https://{prefix}.api.checkout.com/issuing/cards/crd_fa6psq42dcdd6fdn5gifcq1491/revoke",
          "actions": [
            "POST"
          ],
          "types": [
            "application/json"
          ]
        },
        "controls": {
          "href": "https://{prefix}.api.checkout.com/issuing/controls?target_id=crd_fa6psq42dcdd6fdn5gifcq1491",
          "actions": [
            "GET"
          ],
          "types": [
            "application/json"
          ]
        }
      },
      "scheduled_revocation_date": "2027-03-12T00:00:00.0000000",
      "last_activated_on": "2019-09-10T10:11:12.0000000+00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.