Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

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

Cria um comprador no gateway de pagamentos e sincroniza os dados localmente. Se um comprador com o mesmo taxpayer_id já existir no gateway, os dados locais são atualizados em vez de criar um novo registro.

​
Autenticação

Não requer autenticação.

​
Corpo da Requisição

​
first_name
string
required
Nome do comprador
​
last_name
string
required
Sobrenome do comprador
​
email
string
required
E-mail do comprador
​
taxpayer_id
string
CPF do comprador (somente dígitos, 11 caracteres). Se não informado, o comprador é criado sem CPF
​
phone_number
string
Telefone do comprador
​
birthdate
string
Data de nascimento no formato DD-MM-YYYY

​
Resposta

​
success
boolean
Indica se a criação foi bem-sucedida
​
buyer
object
Dados do comprador criado
​
zoop_buyer_id
string
ID do comprador no gateway (mesmo que buyer.id; campo nome do campo conforme contrato da API)
​
is_new
boolean
true se o comprador foi criado agora; false se já existia no gateway

​
Exemplo

curl -X POST "https://api.chargefy.io/api/v1/buyers/" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "João",
    "last_name": "Silva",
    "email": "joao@exemplo.com",
    "taxpayer_id": "123.456.789-01",
    "phone_number": "11999990000",
    "birthdate": "15-06-1990"
  }'

​
Resposta de Exemplo

{
  "success": true,
  "buyer": {
    "id": "gw_buyer_abc123",
    "taxpayer_id": "12345678901",
    "first_name": "João",
    "last_name": "Silva",
    "email": "joao@exemplo.com",
    "phone_number": "11999990000",
    "birthdate": "15-06-1990",
    "status": "active",
    "created_at": "2026-03-20T10:00:00Z"
  },
  "zoop_buyer_id": "gw_buyer_abc123",
  "is_new": true
}