GET /api/v1/buyers/lookup/:email

Busca um comprador pelo e-mail com prioridade: cliente da organização → registro global

Busca um comprador pelo e-mail usando a seguinte ordem de prioridade:

1. Cliente da organização (source: 'customer') — requer organization_id. Consulta a tabela customers da organização.
2. Registro global do gateway (source: 'local') — consulta o cadastro local de compradores do gateway.
3. Não encontrado (source: 'none') — retorna found: false.

​

Autenticação

Não requer autenticação.

​

Parâmetros de Rota

email · string · required

E-mail do comprador a ser buscado

​

Parâmetros de Query

organization_id · string

ID da organização. Quando informado, a busca prioriza clientes da organização

​

Resposta

found · boolean

true se o comprador foi encontrado em alguma fonte

source · string

Fonte onde o comprador foi encontrado: customer, local ou none

buyer · object | null

Dados consolidados do comprador (ou null se não encontrado)

Show Propriedades

taxpayer_id · string

CPF do comprador

first_name · string

Nome

last_name · string

Sobrenome

email · string

E-mail

phone_number · string

Telefone

birthdate · string

Data de nascimento

zoop_buyer_id · string

ID do comprador no gateway (se existir)

local_data · object | null

Dados brutos do registro local (comprador no gateway ou cliente da organização)

​

Exemplo

cURL

curl -X GET "https://api.chargefy.io/api/v1/buyers/lookup/[e-mail]?organization_id=org_abc123" \
  -H "Content-Type: application/json"

​

Resposta de Exemplo

{
  "found": true,
  "source": "customer",
  "buyer": {
    "taxpayer_id": "12345678901",
    "first_name": "João",
    "last_name": "Silva",
    "email": "[e-mail]",
    "phone_number": "11999990000",
    "birthdate": "15-06-1990",
    "zoop_buyer_id": "gw_buyer_abc123"
  },
  "local_data": {
    "buyer_id": "gw_buyer_abc123"
  }
}