Buscar cliente por ID
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/customers/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/customers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/customers/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "cust_kyz6cwnbm55aax1lhxewn01o4",
"name": "Maria Oliveira",
"email": "maria.oliveira@example.com",
"type": "individual",
"document": "12345678909",
"documentType": "cpf",
"phone": "+5511987654321",
"address": {
"street": "Av. Paulista",
"number": "1578",
"complement": "Apto 142",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"postalCode": "01310-200",
"country": "BR"
},
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T13:45:30.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Customer not found"
}
}Clientes
Buscar cliente por ID
Retorna o cadastro atual de um cliente — não o retrato dele no momento de uma compra.
GET
/
customers
/
{id}
Buscar cliente por ID
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/customers/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/customers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/customers/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "cust_kyz6cwnbm55aax1lhxewn01o4",
"name": "Maria Oliveira",
"email": "maria.oliveira@example.com",
"type": "individual",
"document": "12345678909",
"documentType": "cpf",
"phone": "+5511987654321",
"address": {
"street": "Av. Paulista",
"number": "1578",
"complement": "Apto 142",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"postalCode": "01310-200",
"country": "BR"
},
"createdAt": "2025-06-29T13:45:30.000Z",
"updatedAt": "2025-06-29T13:45:30.000Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Customer not found"
}
}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
API Key da Credential (gerada no Backoffice)
Path Parameters
ID do cliente
Response
Dados do cliente
Identificador único do registro.
Nome do registro.
E-mail de contato.
Tipo de lançamento (sale, refund, chargeback, withdrawal, fee, etc)
Documento (CPF ou CNPJ) do titular.
Tipo de documento: cpf ou cnpj.
Telefone de contato.
Endereço do cliente.
Show child attributes
Show child attributes
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).