POST /api/v1/buyers/

Cria um novo comprador no gateway de pagamentos e salva no banco de dados local

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

Show Propriedades

id · string

ID do comprador no gateway

taxpayer_id · string

CPF (se fornecido)

first_name · string

Nome

last_name · string

Sobrenome

email · string

E-mail

phone_number · string

Telefone

birthdate · string

Data de nascimento (DD-MM-YYYY)

status · string

Status do comprador no gateway

created_at · string

Data de criação (ISO 8601)

zoop_buyer_id · string

ID do comprador no gateway (mesmo que buyer.id; campo zoop_buyer_id na API)

is_new · boolean

true se o comprador foi criado agora; false se já existia no gateway

​

Exemplo

cURL

curl -X POST "https://api.chargefy.io/api/v1/buyers/" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "João",
    "last_name": "Silva",
    "email": "[e-mail]",
    "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": "[e-mail]",
    "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
}