Skip to main content
GET
Buscar cliente por ID
GET /customers/:id Faz parte do recurso Clientes — o cadastro, o que o torna único e o efeito da remoção estão lá.
Isto é o cadastro de hoje, não o da compra. Se o cliente mudou de e-mail ou endereço depois de uma venda, é o valor novo que aparece aqui. Para conferir uma transação antiga, use o retrato que ela guarda — customerName, customerEmail, customerDocument e customerAddress em GET /transactions/:id —, que não muda depois de criado.
Cliente removido pelo painel responde 404 — a API não devolve cadastro apagado, e não existe rota de remoção aqui. Veja Clientes.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

id
string
required

ID do cliente

Response

Dados do cliente

id
string

Identificador único do registro.

name
string

Nome do registro.

email
string

E-mail de contato.

type
string

Tipo de lançamento (sale, refund, chargeback, withdrawal, fee, etc)

document
string

Documento (CPF ou CNPJ) do titular.

documentType
string

Tipo de documento: cpf ou cnpj.

phone
string

Telefone de contato.

address
object | null

Endereço do cliente.

createdAt
string<date-time>

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>

Data e hora da última atualização do registro (ISO 8601).