CHcheckout
Digital cards

Get digital card details

Retrieves the details for a digital card.

get/issuing/digital-cards/{digitalCardId}

Request

Path parameters

digitalCardIdstring required

The digital card's unique identifier.

Example:dcr_5ngxzsynm2me3oxf73esbhda6q

Response

Digital card retrieved successfully

idstring required

The digital card's unique identifier.

card_idstring required

The card's unique identifier.

client_idstring required

The client's unique identifier.

entity_idstring required

The entity's unique identifier.

last_fourstring required

The last four digits of the card number, also known as the PAN.

status'active' | 'inactive' | 'deleted' required

The digital card's current status, which determines whether it can approve incoming authorizations:

  • inactive: the default state - authorizations will be declined until the card is activated
  • active: authorization requests can be approved
  • deleted: incoming authorization requests will be declined, permanently — the card cannot be reactivated from this state
type'secure_element' | 'host_card_emulation' | 'card_on_file' | 'e_commerce' | 'qr_code'

The type of digital card

scheme_card_idstring

The ID that the card scheme’s token service provider (TSP) assigns to the PAN at the first tokenization.

provisioned_onstring UTC

Example response

{
  "id": "dcr_5ngxzsynm2me3oxf73esbhda6q",
  "card_id": "crd_fa6psq242dcd6fdn5gifcq1491",
  "client_id": "cli_vkuhvk4vjn2edkps7dfsq6emqm",
  "entity_id": "ent_fa6psq242dcd6fdn5gifcq1491",
  "last_four": "1234",
  "status": "active",
  "type": "secure_element",
  "scheme_card_id": "FAPLMC00002572060f2b2213c3964c44b218665ef9dd0d72",
  "requestor": {
    "id": "501103353211",
    "name": "APPLE PAY"
  },
  "device": {
    "id": "04431C7B514E80018306224737548585F11415F67C4E2EB6",
    "type": "iphone",
    "manufacturer": "ios",
    "os_version": "13",
    "phone_number": "447505551234",
    "device_name": "John's iPhone",
    "time_zone_setting": "network_set",
    "imei": "000000000000024",
    "network_type": "wifi"
  },
  "provisioned_on": "2021-09-09T19:41:39Z",
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/issuing/digital-cards/dcr_5ngxzsynm2me3oxf73esbhda6q",
      "actions": [
        "GET"
      ],
      "types": [
        "application/json"
      ]
    }
  }
}

Changes

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