Skip to main content
POST
Criar cliente
POST /customers Faz parte do recurso Clientes — o cadastro, o que o torna único e a diferença para o comprador da transação estão lá. São obrigatórios nome, e-mail, tipo, documento e telefone. O endereço é opcional e pode ser completado depois.
Pessoa jurídica precisa informar o documentType. Com type: "company", omitir o campo responde 400 — a API não deduz o tipo pelo tamanho do documento. Enviar documentType: "cpf" junto de type: "company" também é recusado, assim como cnpj com individual: são combinações incoerentes.Em type: "individual", omitir assume cpf. Quem usa passaporte informa documentType: "passport".
Documento e e-mail não podem se repetir na sua conta, e a violação responde 409 com error.code — não 400. É conflito com um cadastro existente, não campo malformado. Antes de criar, procure por ?document= para reaproveitar quem já existe.O mesmo 409 também responde quando há uma requisição concorrente com a mesma Idempotency-Key — nesse caso o corpo é { "error": "texto" }, sem code. Ramifique pelo formato, não só pelo status.
O telefone segue E.164+5511987654321, com código do país. Na listagem a busca por telefone ignora pontuação dos dois lados, então o formato aqui não impede reencontrá-lo depois.
Endpoint idempotente. Envie o header Idempotency-Key para que um retry por timeout não crie o mesmo cliente duas vezes. Veja Convenções.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Body

application/json
name
string
required

Nome completo do cliente.

Minimum string length: 2
email
string<email>
required

E-mail do cliente.

type
enum<string>
required

Tipo de cliente: individual (pessoa física) ou company (pessoa jurídica).

Available options:
individual,
company
document
string
required

Documento do cliente (CPF ou CNPJ, somente dígitos).

Minimum string length: 6
phone
string
required

Telefone do cliente (formato E.164, ex.: +5511987654321).

Minimum string length: 1
documentType
enum<string>

Tipo do documento: cpf, cnpj ou passport. Obrigatório quando type é company; em individual, omitir assume cpf.

Available options:
cpf,
cnpj,
passport
address
object

Endereço do cliente.

Response

Cliente criado

id
string

Identificador único do registro.

name
string

Nome do registro.

email
string

E-mail de contato.

type
string

Tipo de lançamento (sale, refund, chargeback, withdrawal, fee, etc)

document
string

Documento (CPF ou CNPJ) do titular.

documentType
string

Tipo de documento: cpf ou cnpj.

phone
string

Telefone de contato.

address
object | null

Endereço do cliente.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).