Esse objeto representa um cliente que fará pagamentos usando seu serviço.
Atributos
id string
O identificador exclusivo do cliente (MAX 64; MIN 36).
Example: faa89e18-5a11-11ed-9b6a-0242ac120002
merchant_customer_id string
O identificador exclusivo do cliente no comerciante externo (MAX 255; MIN 1).
Exemplo: 50ca6f06-5a12-11ed-9b6a-0242ac120002
merchant_customer_created_at carimbo de data/hora
Data de registro do cliente na plataforma de comerciantes (MAX 27; MIN 27 ISO 3166-1).
Example: 2022-05-09T20:46:54.786342Z
first_name string
O primeiro nome do cliente (MAX 255; MIN 1).
Exemplo: João
last_name string
O sobrenome do cliente (MAX 255; MIN 1).
Exemplo: Doe
gender enum
O gênero do cliente (MAX 2; MIN 1).
Valores de enum possíveis: M, F ou NB
date_of_birth string
A data de nascimento do cliente no formato AAAA-MM-DD (MAX 10; MIN 10).
Exemplo: 1990-02-28
email string
O e-mail do cliente (MAX 255; MIN 3).
Exemplo: [email protected]
nationality enum
A nacionalidade do cliente (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
country enum
O país do cliente (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
document objeto
Especifica o objeto de documento do cliente, incluindo seu número e tipo.
document_number string
O número do documento do cliente (MAX 40; MIN 3).
Exemplo: 1093333333
document_type enum
O tipo de documento do cliente (MAX 6; MIN 2).
Possíveis valores de enum: Verifique a referência do país.
phone objeto
Especifica o objeto de número de telefone do cliente.
country_code string
O código de chamada do país do telefone do cliente (MAX 3; MIN 1). Valores possíveis: Verifique o Referência do país.
Exemplo: 57
number string
O número de telefone do cliente, sem o código do país (MAX 32; MIN 1).
Exemplo: 3132450765
billing_address objeto
Especifica o objeto de endereço de cobrança do cliente.
address_line_1 string
A linha do endereço de cobrança principal do cliente (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78
address_line_2 string
A linha de endereço de faturamento secundário do cliente (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I
city string
A cidade considerada para o endereço de cobrança (MAX 255; MIN 3).
Exemplo: Bogotá
country enum
O país considerado para o endereço de cobrança (MAX 2; MIN 2); ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
state string
O estado considerado para o endereço de cobrança (MAX 255; MIN 3; ISO 3166-2).
Exemplo: Cundinamarca
zip_code string
O código postal considerado para o endereço de cobrança (MAX 11; MIN 4).
Exemplo: 111111
neighborhood string
A vizinhança da linha de endereço do cliente (MAX 255; MIN 2)
Exemplo: Barrio 11
shipping_address objeto
Especifica o objeto de endereço de entrega do cliente.
address_line_1 string
A linha do endereço de entrega principal do cliente (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78
address_line_2 string
A linha do endereço de entrega secundário do cliente (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I
city string
A cidade considerada para o endereço de entrega (MAX 255; MIN 3).
Exemplo: Bogotá
country enum
O país considerado para o endereço de entrega (MAX 2; MIN 2); ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.
state string
O estado considerado para o endereço de entrega (MAX 255; MIN 3; ISO 3166-2).
Exemplo: Cundinamarca
zip_code string
O CEP considerado para o endereço de entrega (MAX 10; MIN 5).
Exemplo: 111111
neighborhood string
A vizinhança da linha de endereço do cliente (MAX 255; MIN 2)
Exemplo: Barrio 11
metadata matriz de objetos
Especifica uma lista de pares de valores-chave personalizados associados ao cliente (para referências internas, segmentação ou tags de fluxo de trabalho). Você pode adicionar até 50 objetos de metadados.
metadata object objeto
Especifica uma chave de metadados e o respectivo valor.
Use para anexar o contexto definido pelo comerciante (por exemplo: crm_id, segment). Evite enviar dados confidenciais ou pessoais.
crm_id, segment). Evite enviar dados confidenciais ou pessoais.key string
Especifica uma chave de metadados.
Exemplo: idade
value string
Especifica o valor da chave de metadados definida.
Exemplo: 28
created_at carimbo de data/hora
Data e hora de criação do cliente (MAX 27; MIN 27; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z
updated_at carimbo de data/hora
Data e hora da última atualização do cliente (MAX 27; MIN 27); ISO 8601).
Example: 2022-05-09T20:46:54.786342Z