Crair cliente

---

A rota de criação de cliente permite registrar um novo cliente na plataforma. Essas informações serão usadas posteriormente para emissão de boletos, gerenciamento de cobranças e acompanhamento financeiro.

---

Autenticação

Esta rota exige autenticação via Api Key.

cURL da chamada

curl -X POST https://api.onnixpay.com/api/v1/sdk/customers \
    -H "X-API-Key: ox_your_key" \
    -d '{
        "name": "João Silva",
        "email": "joao@email.com",
        "documentNumber": "12345678900",
        "phoneNumber": "+5511999999999",
        "address": {
          "postalCode": "01234-567",
          "street": "Rua das Flores",
          "number": "123",
          "complement": "Apto 45",
          "neighborhood": "Centro",
          "city": "São Paulo",
          "state": "SP"
        },
        "notes": "Cliente VIP"
      }'

Descrição dos campos

Campo	Tipo	Obrigatório	Descrição
name	string	✔️	Nome completo do cliente
email	string	✔️	E-mail de contato
documentNumber	string	✔️	CPF ou CNPJ do cliente
phoneNumber	string	✔️	Telefone com DDI e DDD
address.postalCode	string	✔️	Endereço completo
address.street	string	✔️	Endereço completo
address.number	string	✔️	Endereço completo
address.complement	string	✖️	Endereço completo
address.neighborhood	string	✔️	Endereço completo
address.city	string	✔️	Endereço completo
address.state	string	✔️	Endereço completo
notes	string	✖️	Observações adicionais

Exemplo de retorno

Sucesso 201

{
  "success": true,
  "data": {
    "id": "cust_abc123xyz",
    "name": "João Silva",
    "email": "joao@email.com",
    "documentNumber": "12345678900",
    "phoneNumber": "+5511999999999",
    "status": "ACTIVE",
    "createdAt": "2025-10-11T10:30:00Z"
  }
}