Skip to main content
POST
/
api
/
customers
Criar Cliente
curl --request POST \
  --url https://api.example.com/api/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "document": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "address": {
    "street": "<string>",
    "streetNumber": "<string>",
    "complement": "<string>",
    "neighborhood": "<string>",
    "zipCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>"
  }
}
'

​
Criar Cliente

Cria um novo cliente ou atualiza os dados de um cliente existente. A identificação é feita pelo campo document (CPF/CNPJ). Se um cliente com o mesmo documento já existir no projeto, seus dados serão atualizados.
Clientes também são criados automaticamente ao criar uma transação PIX. Este endpoint é útil para pré-cadastrar clientes antes de criar transações.

​
Autenticação

Authorization: Bearer sk_test_xxx

​
Request Body

​
name
string
required
Nome completo do cliente. Máximo 255 caracteres.
​
document
string
required
CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números.
​
email
string
required
Email do cliente.
​
phone
string
required
Telefone do cliente (10-15 dígitos).
​
address
object
required

​
Response

201 — Cliente criado: 
{
  "success": true,
  "message": "Customer created successfully",
  "data": {
    "id": "cly1234567890",
    "name": "João Silva",
    "document": "12345678900",
    "email": "[email protected]",
    "phone": "11999999999",
    "street": "Rua Exemplo",
    "streetNumber": "123",
    "neighborhood": "Centro",
    "complement": null,
    "zipCode": "01310100",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "isBlocked": false,
    "createdAt": "2026-01-16T10:00:00.000Z",
    "updatedAt": "2026-01-16T10:00:00.000Z"
  }
}
200 — Cliente atualizado (documento já existia): 
{
  "success": true,
  "message": "Customer updated successfully",
  "data": { ... }
}

​
Erros

HTTPCódigoDescrição
400ERR_VALIDATION_001Body inválido
401ERR_AUTH_009Token inválido

Precisa de ajuda?

Nossa equipe está disponível para auxiliar no processo de desenvolvimento. Entre em contato pelo e-mail [email protected].