CHcheckout
Customers

Get customer details

Returns the details of a customer and their payment instruments.

get/customers/{identifier}

Request

Path parameters

string required
OR
string email required

The customer's ID or email

Response

Customer retrieved successfully

idstring required

The customer's unique identifier

emailstring email required

The customer's email address

defaultstring

The ID for this customer's default instrument

namestring

The customer's name

metadataobject

A set of key-value pairs that is attached to a customer

Example response

{
  "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "email": "brucewayne@gmail.com",
  "default": "src_wmlfc3zyhqzehihu7giusaaawu",
  "name": "Bruce Wayne",
  "phone": {
    "country_code": "+1",
    "number": "415 555 2671"
  },
  "metadata": {
    "coupon_code": "NY2018",
    "partner_id": 123989
  },
  "instruments": [
    {
      "type": "card",
      "id": "src_wmlfc3zyhqzehihu7giusaaawu",
      "fingerprint": "vnsdrvikkvre3dtrjjvlm5du4q",
      "expiry_month": 6,
      "expiry_year": 2025,
      "scheme": "VISA",
      "last4": 9996,
      "bin": 454347,
      "card_type": "CREDIT",
      "card_category": "CONSUMER",
      "issuer": "TEST STATE BANK",
      "issuer_country": "US",
      "product_id": "F",
      "product_type": "CLASSIC",
      "account_holder": {
        "first_name": "John",
        "last_name": "Smith",
        "billing_address": {
          "address_line1": "123 High St.",
          "address_line2": "Flat 456",
          "city": "London",
          "zip": "SW1A 1AA",
          "country": "GB"
        },
        "phone": {
          "country_code": 1,
          "number": "415 555 2671"
        }
      },
      "card_wallet_type": "applepay"
    }
  ]
}

Changes

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