Skip to main content
POST
Criar cliente
Cadastra um novo cliente vinculado ao seu merchant.

Obrigatório

Apenas email é obrigatório. Inclua name, taxId e phone sempre que tiver — facilita relatórios e melhora a experiência no PIX.
Exemplo:
Guarde o data.id retornado e passe como customerId em POST /transparents/create — o cliente é vinculado automaticamente à cobrança.
taxId é único por merchant. Se já existir um customer com o mesmo taxId, a API responde 409 CONFLICT em vez de criar duplicidade.

Authorizations

Authorization
string
header
required

Autentique suas requisições enviando o token no header Authorization: Bearer <token>.

O token pode ser:

Não há distinção de ambiente — toda chave vale para o único ambiente disponível (produção).

Body

application/json
email
string<email>
required
Example:

"joao@exemplo.com"

name
string
Required string length: 1 - 120
Example:

"João Silva"

taxId
string

CPF (11 dígitos) ou CNPJ (14 dígitos) — apenas números aceitos na validação, mas você pode enviar formatado.

Example:

"12345678900"

phone
string
Maximum string length: 20
Example:

"+5511999999999"

Response

Cliente criado com sucesso.

data
object
required
error
null
required
Example:

null

success
enum<boolean>
required
Available options:
true
Example:

true