Listar chaves PIX da subconta
GET
/api/subaccounts/{{subaccount_id}}/pix-keys
Autenticação
subaccounts:read e a conta precisa da flag white-label habilitada. Sem a flag, a rota responde 404 (invisível).Listar chaves PIX da subconta
subaccounts:readResposta
200 OK com { data: [ ... ] }. Cada item:| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID da chave. |
type | string | CPF / CNPJ / EMAIL / PHONE / RANDOM. |
key | string | Valor normalizado da chave. |
name | string | Nome do titular. |
status | string | PENDING_APPROVAL / APPROVED / REJECTED. |
rejectionReason | string|null | Motivo da recusa (quando REJECTED). |
isDefault | boolean | Se é a chave padrão. |
createdAt | string (ISO) | Data de criação. |
reviewedAt | string|null (ISO) | Data da decisão admin. |
Códigos de erro
| HTTP | Quando |
|---|---|
401 | Sem header Authorization ou chave inválida/revogada. |
403 | Chave sem o escopo subaccounts:read (insufficient_scope). |
404 | Flag white-label desabilitada, subconta inexistente ou não pertence ao master. |
Exemplo cURL
Requisição
Parâmetros Header
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff '/api/subaccounts/{{subaccount_id}}/pix-keys' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"data": [
{
"id": "clpixkey0002",
"type": "CNPJ",
"key": "12345678000199",
"name": "Empresa Exemplo LTDA",
"status": "PENDING_APPROVAL",
"rejectionReason": null,
"isDefault": false,
"createdAt": "2026-06-13T14:25:00.000Z",
"reviewedAt": null
},
{
"id": "clpixkey0001",
"type": "EMAIL",
"key": "financeiro@empresa-exemplo.com",
"name": "Empresa Exemplo LTDA",
"status": "APPROVED",
"rejectionReason": null,
"isDefault": true,
"createdAt": "2026-06-10T09:00:00.000Z",
"reviewedAt": "2026-06-11T10:00:00.000Z"
}
]
}Modificado em 2026-07-02 06:57:27