Skip to main content

Visão geral

Use este endpoint para cadastrar um novo cliente na sua conta. Os clientes podem ser associados a transações, assinaturas e links de pagamento, facilitando a gestão de relacionamento e a conciliação financeira.

Endpoint

Parâmetros do corpo

string
required
Nome completo ou razão social do cliente.
string
required
Endereço de e-mail do cliente, utilizado para comunicações e identificação.
string
required
CPF ou CNPJ do cliente, sem pontuação.
string
Número de telefone do cliente, no formato E.164 (ex: +5511999999999).
object
Conjunto de pares chave-valor para armazenar informações adicionais sobre o cliente.

Resposta

string
Identificador único do cliente, no formato cus_xxxxxxxxxxxx.
string
Nome completo ou razão social do cliente.
string
Endereço de e-mail do cliente.
string
CPF ou CNPJ do cliente.
string
Número de telefone do cliente.
string
Data e hora de criação do cliente, no formato ISO 8601.

Exemplo de resposta

Verifique se o e-mail e o documento informados são válidos e únicos. Tentativas de cadastro com documentos já existentes retornarão erro 409 Conflict.

Erros comuns

Próximos passos

Listar clientes

Consulte todos os clientes cadastrados.

Editar cliente

Atualize os dados de um cliente existente.