> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Buscar cliente por ID
> Retorna o cadastro atual de um cliente — não o retrato dele no momento de uma compra.
`GET /customers/:id`
Faz parte do recurso [Clientes](/pt-BR/customers) — 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`](/pt-BR/transactions/get) —, 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](/pt-BR/customers#não-há-como-remover-pela-api).
## OpenAPI
````yaml openapi/psp.json GET /customers/{id}
openapi: 3.0.3
info:
title: Z2Pay PSP API
version: 1.0.0
description: API pública do PSP — autenticação via API Key (Credential)
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Cards
description: Cartões salvos de um cliente
- name: Chargebacks
description: Gerenciamento de chargebacks
- name: Customers
description: Gerenciamento de clientes (compradores)
- name: Fees
description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
- name: Recipients
description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
- name: Refunds
description: Gerenciamento de reembolsos e estornos
- name: Splits
description: Regras de divisão do valor de uma venda entre recebedores
- name: Transactions
description: Gerenciamento de transações e payments
- name: Wallets
description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
- name: Webhooks
description: Configuração, gerenciamento e histórico de entregas de webhooks
- name: Withdrawals
description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
/customers/{id}:
get:
tags:
- Customers
summary: Buscar cliente por ID
description: Retorna os dados de um cliente.
operationId: CustomerController_getById
parameters:
- name: id
in: path
required: true
description: ID do cliente
schema:
type: string
responses:
'200':
description: Dados do cliente
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Identificador único do registro.
name:
type: string
description: Nome do registro.
email:
type: string
description: E-mail de contato.
type:
type: string
description: >-
Tipo de lançamento (sale, refund, chargeback, withdrawal,
fee, etc)
document:
type: string
description: Documento (CPF ou CNPJ) do titular.
documentType:
type: string
description: 'Tipo de documento: cpf ou cnpj.'
phone:
type: string
description: Telefone de contato.
address:
type: object
nullable: true
properties:
street:
type: string
nullable: true
description: Logradouro (rua, avenida).
number:
type: string
nullable: true
description: Número do endereço.
complement:
type: string
nullable: true
description: Complemento do endereço (apartamento, bloco, sala).
neighborhood:
type: string
nullable: true
description: Bairro.
city:
type: string
nullable: true
description: Cidade.
state:
type: string
nullable: true
description: 'Estado ou UF (ex.: SP).'
postalCode:
type: string
nullable: true
description: CEP / código postal (somente dígitos).
country:
type: string
nullable: true
description: 'País (código ISO 3166-1 alfa-2, ex.: BR).'
description: Endereço do cliente.
createdAt:
type: string
format: date-time
description: Data e hora de criação do registro (ISO 8601).
updatedAt:
type: string
format: date-time
description: Data e hora da última atualização do registro (ISO 8601).
example:
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'
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
'404':
description: Cliente não encontrado
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: NOT_FOUND
message: Customer not found
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````