card_created

Last updated: June 19, 2024


1{
2  "id": "evt_az5sblvku4ge3dwpztvyizgcau",
3  "type": "card_created",
4  "version": "2.0.0",
5  "created_on": "2018-04-10T08:13:14Z",
6  "data":
7      {
8        "card_id": "crd_z7clkniyb3ourbpzx2dvl67654",
9        "cardholder_id": "crh_z7clkniyb3ourbpzx2dvl67654",
10        "entity_id": "ent_z7clkniyb3ourbpzx2dvl67654",
11        "card_product_id": "pro_ybfbv7arqzvujjtpzvi2el5dhy",
12        "type": "physical",
13        "is_single_use": "false",
14        "last_four": "1234",
15        "status": "Active",
16        "issuing_country": "GB",
17        "reference": "Reference",
18        "billing_currency": "GBP",
19        "metadata": {
20          "udf1": "metadata1",
21          "udf2": "metadata2",
22          "udf3": "metadata3",
23          "udf4": "metadata4",
24          "udf5": "metadata5"
25        },
26        "expiry_month": 11,
27        "expiry_year": 2028,
28        "revocation_date": "2027-03-12",
29        "created_on": "2018-04-10T08:12:14Z"
30  }
31}

Field name Description

Field name	Description
`card_id` string	The card's unique Checkout.com identifier.
`cardholder_id` string	The unique Checkout.com identifier of the cardholder for whom the card was created.
`entity_id` string	The unique Checkout.com identifier of the client entity for which the card was created.
`card_product_id` string	The unique Checkout.com identifier of the card product in which the card was created.
`type` string	The card type. This can be one of: `physical` `virtual`
`is_single_use` boolean	(Optional) Specifies if the card is single use.
`last_four` string	The last four digits of the card number.
`status` string	The status of the card. This can be one of: `Inactive` `Active`
`issuing_country` string	The two character ISO country code of the card account range.
`reference` string	(Optional) The card's reference.
`billing_currency` string	The three character ISO currency code of the card account range.
`metadata` object	(Optional) Information about the card's metadata. See the Metadata section for more details.
`expiry_month` integer	The month the card expires.
`expiry_year` integer	The year the card expires.
`revocation_date` string	(Optional) The date for the card to be automatically revoked in the format `yyyy-mm-dd`. This date will always be past the current date.
`created_on` string	The date and time when the card was created.

card_id

string

The card's unique Checkout.com identifier.

cardholder_id

string

The unique Checkout.com identifier of the cardholder for whom the card was created.

entity_id

string

The unique Checkout.com identifier of the client entity for which the card was created.

card_product_id

string

The unique Checkout.com identifier of the card product in which the card was created.

type

string

The card type. This can be one of:

physical
virtual

is_single_use

boolean

(Optional) Specifies if the card is single use.

last_four

string

The last four digits of the card number.

status

string

The status of the card. This can be one of:

Inactive
Active

issuing_country

string

The two character ISO country code of the card account range.

reference

string

(Optional) The card's reference.

billing_currency

string

The three character ISO currency code of the card account range.

metadata

object

(Optional) Information about the card's metadata. See the Metadata section for more details.

expiry_month

integer

The month the card expires.

expiry_year

integer

The year the card expires.

revocation_date

string

(Optional) The date for the card to be automatically revoked in the format yyyy-mm-dd. This date will always be past the current date.

created_on

string

The date and time when the card was created.

Field name	Description
`udf1` string	User defined field 1
`udf2` string	User defined field 2
`udf3` string	User defined field 3
`udf4` string	User defined field 4
`udf5` string	User defined field 5

card_created

Example: Card created

Webhook response fields

Metadata