El Objeto Customer

Este objeto caracteriza al cliente que realizará pagos utilizando su servicio.

Atributos

id string
El identificador único del cliente (MAX 64; MIN 36).
Ejemplo: faa89e18-5a11-11ed-9b6a-0242ac120002

merchant_customer_id string
El identificador único del cliente en el comerciante externo (MAX 255; MIN 1).
Ejemplo: 50ca6f06-5a12-11ed-9b6a-0242ac120002

merchant_customer_created_at marca de tiempo
Fecha de registro del cliente en la plataforma de comerciantes (MAX 27; MIN 27 ISO 3166-1).
Ejemplo: 2022-05-09T20:46:54.786342Z

first_name string
El nombre del cliente (MÁX 255; MÍN 1).
Ejemplo: John

last_name string
El apellido del cliente (MÁX 255; MÍN 1).
Ejemplo: Doe

gender enum
El género del cliente (MAX 2; MIN 1).
Posibles valores de enum: M, F o NB

date_of_birth string
Fecha de nacimiento del cliente en formato AAAA-MM-DD (MÁX 10; MÍN 10).
Ejemplo: 1990-02-28

email string
El e-mail del cliente (MÁX 255; MÍN 3).
Ejemplo: [email protected]

nationality enum
La nacionalidad del cliente (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

country enum
El país del cliente (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

document objeto

Especifica el objeto de documento del cliente, incluido su número y tipo.

document_number string
El número de documento del cliente (MÁX 40; MÍN 3).
Ejemplo: 1093333333

document_type enum
Tipo de documento del cliente (MAX 6; MIN 2).
Posibles valores del enum: Compruebe la referencia del país.

phone objeto

Especifica el objeto Phone Number del cliente.

country_code string
El código de llamada del país del teléfono del cliente (MAX 3; MIN 1). Valores posibles: Comprobar el Referencia de país.
Ejemplo: 57

number string
El número de teléfono del cliente, sin el código del país (MAX 32; MIN 1).
Ejemplo: 3132450765

billing_address objeto

Especifica el objeto de dirección de facturación del cliente.

address_line_1 string
La línea de dirección de facturación principal del cliente (MÁX 255; MÍN 3).
Ejemplo: Calle 34 # 56 - 78

address_line_2 string
La línea de dirección de facturación secundaria del cliente (MÁX 255; MÍN 3).
Ejemplo: Apartamento 502, Torre I

city string
La ciudad considerada para la dirección de facturación (MÁX 255; MÍN 3).
Ejemplo: Bogotá

country enum
El país considerado para la dirección de facturación (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

state string
El estado considerado para la dirección de facturación (MAX 255; MIN 3; ISO 3166-2).
Ejemplo: Cundinamarca

zip_code string
El código postal considerado para la dirección de facturación (MÁX 11; MÍN 4).
Ejemplo: 111111

neighborhood string
La vecindad de la línea de dirección del cliente(MAX 255; MIN 2)
Ejemplo: Barrio 11

shipping_address objeto

Especifica el objeto de dirección de envío del cliente.

address_line_1 string
La línea de dirección de envío principal del cliente (MÁX 255; MÍN 3).
Ejemplo: Calle 34 # 56 - 78

address_line_2 string
La línea de dirección de envío secundaria del cliente (MÁX 255; MÍN 3).
Ejemplo: Apartamento 502, Torre I

city string
La ciudad considerada para la dirección de envío (MÁX 255; MÍN 3).
Ejemplo: Bogotá

country enum
El país considerado para la dirección de envío (MÁX 2; MÍN 2; ISO 3166-1).
Posibles valores del enum: Compruebe la referencia del país.

state string
El estado considerado para la dirección de envío (MAX 255; MIN 3; ISO 3166-2).
Ejemplo: Cundinamarca

zip_code string
El código postal considerado para la dirección de envío (MÁX 10; MÍN 5).
Ejemplo: 111111

neighborhood string
La vecindad de la línea de dirección del cliente(MAX 255; MIN 2)
Ejemplo: Barrio 11

metadata array de objects

Especifica una lista de pares clave-valor personalizados asociados al cliente (para referencias internas, segmentación o etiquetas de flujo de trabajo). Puedes añadir hasta 50 objetos de metadatos.

metadata object objeto

Especifica una clave de metadatos y el valor respectivo.

Se utiliza para adjuntar un contexto definido por el comerciante (por ejemplo: crm_id, segment). Evita enviar datos sensibles o personales.

key string
Especifica una clave de metadatos.
Ejemplo: edad

value string
Especifica el valor de la clave de metadatos definida.
Ejemplo: 28

created_at marca de tiempo
Fecha y hora de creación del cliente (MAX 27; MIN 27; ISO 8601).
Ejemplo: 2022-05-09T20:46:54.786342Z

updated_at marca de tiempo
Fecha y hora de la última actualización del cliente (MAX 27; MIN 27; ISO 8601).
Ejemplo: 2022-05-09T20:46:54.786342Z