Skip to main content
POST
/
customers
/
create
Criar um cliente
curl --request POST \
  --url https://api.abacatepay.com/v2/customers/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "daniel_lima@abacatepay.com"
}
'
{
  "data": {
    "id": "cust_aebxkhDZNaMmJeKsy0AHS0FQ",
    "devMode": true,
    "name": "Daniel Lima",
    "cellphone": "(11) 4002-8922",
    "email": "daniel_lima@abacatepay.com",
    "taxId": "123.456.789-01",
    "country": "BR",
    "zipCode": "01310-100",
    "metadata": {
      "source": "landing-page",
      "campaign": "black-friday-2025"
    }
  },
  "error": null,
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt

Use this file to discover all available pages before exploring further.

Cadastra um cliente para pré-preencher o checkout e reutilizar em várias cobranças.

Obrigatório

Só data.email é obrigatório. Inclua name, taxId e cellphone sempre que tiver — melhora a experiência no checkout.
Exemplo: 
{
  "data": {
    "email": "joao@exemplo.com",
    "name": "João Silva",
    "taxId": "12345678900",
    "cellphone": "+5511999999999",
    "zipCode": "01310-100"
  },
  "metadata": { "plano": "premium" }
}
Guarde o data.id retornado e passe como customerId ao criar checkouts — o cliente não precisa preencher os dados novamente.
Cliente é único por CPF/CNPJ. Se já existir um cadastro com o mesmo taxId, a API devolve o registro existente em vez de criar um duplicado.

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:

"123.456.789-01"

​
zipCode
string

CEP do cliente (opcional)

Example:

"01310-100"

​
metadata
object

Metadados adicionais do cliente. Campo livre para a sua aplicação (opcional)

Example:
{
  "source": "landing-page",
  "campaign": "black-friday-2025"
}

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