v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Retrieve Customer by External ID

get/customers

Query parameters

merchant_customer_idstring

The unique identifier of the customer in the external merchant (MAX 255; MIN 1).

Response

200

idstring
merchant_customer_idstring
first_namestring
last_namestring
genderstring
date_of_birthstring
emailstring
nationalitystring
countrystring
created_atstring
updated_atstring
merchant_customer_created_atstring

Example response

{
  "id": "94121f98-98f7-4d57-aa5f-228401d35b12",
  "merchant_customer_id": "1744402154",
  "first_name": "John",
  "last_name": "Doe",
  "gender": "F",
  "date_of_birth": "1990-02-28",
  "email": "john.doe@gmail.com",
  "nationality": "CO",
  "country": "CO",
  "document": {
    "document_type": "CC",
    "document_number": "1010268952"
  },
  "phone": {
    "number": "3132450765",
    "country_code": "57"
  },
  "billing_address": {
    "address_line_1": "Calle 34 # 56 - 78",
    "address_line_2": "Apartamento 502, Torre I",
    "country": "CO",
    "state": "Cundinamarca",
    "city": "Bogotá",
    "zip_code": "111111",
    "neighborhood": "Test"
  },
  "shipping_address": {
    "address_line_1": "Calle 34 # 56 - 78",
    "address_line_2": "Apartamento 502, Torre I",
    "country": "CO",
    "state": "Cundinamarca",
    "city": "Bogotá",
    "zip_code": "111111",
    "neighborhood": "Test"
  },
  "metadata": [
    {
      "key": "ID",
      "value": "1234"
    }
  ],
  "created_at": "2025-04-11T20:09:14.927971Z",
  "updated_at": "2025-04-11T20:09:14.927972Z",
  "merchant_customer_created_at": "2023-08-05T14:43:58.980718Z"
}