Skip to main content
GET
/
api
/
customers
/
:id
Buscar Cliente
curl --request GET \
  --url https://api.example.com/api/customers/:id
{
  "data.isBlocked": true,
  "data.blockedAt": {},
  "data.blockedReason": {},
  "data.blockExpiresAt": {},
  "data.blockType": {},
  "data.recentTransactions": [
    {}
  ],
  "data.totalTransactions": 123
}

​
Buscar Cliente

Retorna os detalhes completos de um cliente, incluindo endereço, status de bloqueio e as transações mais recentes.

​
Autenticação

Authorization: Bearer sk_test_xxx

​
Path Parameters

​
id
string
required
ID do cliente (formato CUID).

​
Response (200)

{
  "success": true,
  "data": {
    "id": "cly1234567890",
    "projectId": "clp1234567890",
    "name": "João Silva",
    "document": "12345678900",
    "phone": "11999999999",
    "email": "[email protected]",
    "street": "Rua Exemplo",
    "streetNumber": "123",
    "neighborhood": "Centro",
    "complement": null,
    "zipCode": "01310100",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "isBlocked": false,
    "blockedAt": null,
    "blockedReason": null,
    "blockExpiresAt": null,
    "blockType": null,
    "createdAt": "2026-01-16T10:00:00.000Z",
    "updatedAt": "2026-01-16T10:00:00.000Z",
    "recentTransactions": [
      {
        "id": "clx7a8b9c0d1e2f3g4h5",
        "amountCents": 10000,
        "status": "paid",
        "product": "Plano Premium",
        "createdAt": "2026-01-16T10:00:00.000Z",
        "paidAt": "2026-01-16T10:05:00.000Z"
      }
    ],
    "totalTransactions": 5
  }
}
​
data.isBlocked
boolean
Indica se o cliente está bloqueado. Clientes bloqueados não podem criar novas transações.
​
data.blockedAt
string | null
Data/hora do bloqueio (ISO 8601). null se não está bloqueado.
​
data.blockedReason
string | null
Motivo do bloqueio. null se não está bloqueado.
​
data.blockExpiresAt
string | null
Data/hora de expiração do bloqueio (ISO 8601). null se o bloqueio é permanente ou não está bloqueado.
​
data.blockType
string | null
Tipo do bloqueio (ex: manual, fraud). null se não está bloqueado.
​
data.recentTransactions
array
Últimas transações do cliente com id, valor, status, produto e datas.
​
data.totalTransactions
integer
Número total de transações do cliente no projeto.

​
Erros

HTTPCódigoDescrição
401ERR_AUTH_009Token inválido
404ERR_CUSTOMER_001Cliente não encontrado

Precisa de ajuda?

Nossa equipe está disponível para auxiliar no processo de desenvolvimento. Entre em contato pelo e-mail [email protected].