CHcheckout
Cardholders

Create a cardholder

Create a new cardholder that you can <a href="https://www.checkout.com/docs/card-issuing/issue-a-card">issue a card</a> to at a later point.

post/issuing/cardholders

Request

Request body

typestring required

The type of cardholder to create.

referencestring

Your reference.

entity_idstring required

The entity's unique identifier.

first_namestring required

The cardholder's first name.

middle_namestring

The cardholder's middle name.

last_namestring required

The cardholder's last name.

emailstring email

The cardholder's email address.

Emails are validated against the <a href="https://datatracker.ietf.org/doc/html/rfc6530">rfc6530</a> standard.

date_of_birthstring date

The cardholder's date of birth. <br/>Format – YYYY-MM-DD

Example request

{
  "type": "individual",
  "reference": "X-123456-N11",
  "entity_id": "ent_fa6psq242dcd6fdn5gifcq1491",
  "first_name": "John",
  "middle_name": "Fitzgerald",
  "last_name": "Kennedy",
  "email": "john.kennedy@myemaildomain.com",
  "phone_number": {
    "country_code": "+1",
    "number": "415 555 2671"
  },
  "date_of_birth": "1985-05-15T00:00:00.0000000",
  "billing_address": {
    "address_line1": "Checkout.com",
    "address_line2": "90 Tottenham Court Road",
    "city": "London",
    "state": "London",
    "zip": "W1T 4TJ",
    "country": "GB"
  },
  "residency_address": {
    "address_line1": "Checkout.com",
    "address_line2": "90 Tottenham Court Road",
    "city": "London",
    "state": "London",
    "zip": "W1T 4TJ",
    "country": "GB"
  }
}

Response

Cardholder created successfully

idstring required

The cardholder's unique identifier.

client_idstring required

The client's unique identifier.

entity_idstring required

The entity's unique identifier.

type'individual' required

The cardholder's type.

status'active' | 'pending' | 'restricted' | 'requirements_due' | 'inactive' | 'rejected' required

The cardholder's status, after creation.

referencestring

Your reference.

created_datestring date-time
last_modified_datestring date-time

Example response

{
  "id": "crh_d3ozhf43pcq2xbldn2g45qnb44",
  "client_id": "cli_vkuhvk4vjn2edkps7dfsq6emqm",
  "entity_id": "ent_fa6psq242dcd6fdn5gifcq1491",
  "reference": "X-123456-N11",
  "last_modified_date": "2019-09-10T10:11:12.0000000+00:00",
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/issuing/cardholders/crh_d3ozhf43pcq2xbldn2g45qnb44",
      "actions": [
        "GET"
      ],
      "types": [
        "application/json"
      ]
    },
    "cards": {
      "href": "https://{prefix}.api.checkout.com/issuing/cards",
      "actions": [
        "POST"
      ],
      "types": [
        "application/json"
      ]
    }
  }
}

Changes

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