Skip to main content
POST
Criar um cliente
Cadastra um cliente para cobrar sem pedir os dados de novo no checkout. Se o cliente já existe, devolve o cadastro existente atualizado.
Requer a permissão CUSTOMER:CREATE.

Entenda os clientes

Campos, como a AbacatePay evita duplicados e quando o checkout pula a etapa de dados.
Só email é obrigatório, e o corpo é plano (sem data). Exemplo mínimo:
Exemplo completo:

Erros

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json

Os dados do seu cliente.

Obrigatório: Apenas email é obrigatório.

Opcional mas recomendado: name, cellphone, taxId, zipCode e metadata são opcionais, mas recomendados para melhor experiência do cliente.

email
string
required

E-mail do cliente (obrigatório)

Example:

"daniel_lima@abacatepay.com"

name
string

Nome completo do seu cliente (opcional)

Example:

"Daniel Lima"

cellphone
string

Celular do cliente (opcional)

Example:

"(11) 4002-8922"

taxId
string

CPF ou CNPJ válido do cliente (opcional)

Example:

"111.444.777-35"

zipCode
string

CEP do cliente (opcional)

Example:

"01310-100"

address
object

Endereço completo do cliente (opcional). Se enviado, todos os campos menos complement são obrigatórios.

metadata
object

Metadados adicionais do cliente. Campo livre para a sua aplicação (opcional). Os valores precisam ser texto: número ou objeto é recusado.

Example:

Response

Cliente criado com sucesso.

data
object

Os dados do seu cliente.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true