Listar chaves Pix
GET /accounts/:accountId/pix/keys — todas as chaves cadastradas na conta.
Listar chaves Pix
Lista as chaves Pix cadastradas na conta (EVP, CPF, CNPJ, EMAIL e PHONE). Cada item tem o mesmo shape do objeto key retornado por POST /pix/keys — use o id pra remoção via DELETE /pix/keys/:key (no DELETE o path param é o valor da chave, não o id).
GET/accounts/:accountId/pix/keys
Listagem completa em uma única resposta — sem paginação. Limite prático segue a regulação do BCB (até 5 chaves por CPF; até 20 por CNPJ). Pra remover, use DELETE /accounts/:accountId/pix/keys/:key passando o valor da chave URL-encoded — não o id.
Path params
- accountIdObrigatóriostring (UUID)ID da conta dona das chaves.
Headers
- AcceptObrigatóriostringapplication/json
- AuthorizationObrigatóriostringBearer <token> — JWT de /authenticate.
- X-Tenant-IdObrigatóriostring (UUID)Identificador do tenant.
Exemplo de requisição
bash
curl -X GET https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/pix/keys \ -H "Accept: application/json" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \ -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000"Resposta
- keysarrayChaves Pix da conta.
- keys[].idstring (UUID)ID interno da chave.
- keys[].keystringValor da chave: e-mail, telefone E.164, CPF/CNPJ apenas dígitos ou UUID (em EVP).
- keys[].type"EVP" | "CPF" | "CNPJ" | "EMAIL" | "PHONE"Tipo da chave.
- keys[].status"ACTIVE" | "INACTIVE"Estado da chave. Só chaves ACTIVE conseguem receber Pix.
json
{ "keys": [ { "id": "00000000-0000-0000-0000-0000000000b1", "key": "00000000-0000-0000-0000-0000000000c0", "type": "EVP", "status": "ACTIVE" }, { "id": "00000000-0000-0000-0000-0000000000b2", "key": "fulano@example.com", "type": "EMAIL", "status": "ACTIVE" }, { "id": "00000000-0000-0000-0000-0000000000b3", "key": "00000000-0000-0000-0000-0000000000c1", "type": "EVP", "status": "ACTIVE" } ]}URL base:
https://baas.staterpay.io