Listar favoritos Pix

Lista os contatos Pix favoritados pela conta. Cada favorito traz a chave salva, alias customizado e um snapshot DICT (keyInfo) com nome do titular, banco, ISPB e documento mascarado.

GET/accounts/:accountId/pix/favorites

Paginação por página (page/totalPages/hasNextPage) — distinta da paginação por cursor usada em /transactions. keyInfo é um snapshot DICT cacheado: se o titular mudar de banco, o favorito mantém os dados antigos até alguém disparar uma atualização. alias é o apelido customizado pelo usuário (ex.: "Pix do João") — quando null, use favorites[].name para exibição.

Path params

accountIdObrigatório
string (UUID)
ID da conta.

Query string

page
number
Página (zero-indexed). Default 0.
limit
number
Tamanho da página. Default 20, máximo 100.

Headers

AcceptObrigatório
string
application/json
AuthorizationObrigatório
string
Bearer <token> — JWT de /authenticate.
X-Tenant-IdObrigatório
string (UUID)
Identificador do tenant.

Exemplo de requisição

curl https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/pix/favorites \  -H "Accept: application/json" \  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \  -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000"

Resposta

favorites
array
Favoritos da conta.
favorites[].id
string (UUID)
ID do favorito.
favorites[].alias
string | null
Apelido customizado para exibição. null quando não definido.
favorites[].key
string
Valor bruto da chave Pix salva.
favorites[].keyType
"EMAIL" | "PHONE" | "CPF" | "CNPJ" | "EVP"
Tipo da chave.
favorites[].name
string
Nome do titular (snapshot no momento do salvamento).
favorites[].createdAt
string (ISO-8601 UTC)
Quando foi favoritado.
favorites[].updatedAt
string (ISO-8601 UTC)
Última atualização (ex.: refresh dos dados DICT, mudança de alias).
favorites[].keyInfo
object
Snapshot DICT da chave no momento da última atualização.
favorites[].keyInfo.id
string (UUID)
ID interno da consulta DICT.
favorites[].keyInfo.key
string
Chave (eco).
favorites[].keyInfo.keyType
string
Tipo (eco).
favorites[].keyInfo.name
string
Nome do titular.
favorites[].keyInfo.document
string
Documento mascarado (ex.: ***456789** para CPF) por regulação BCB.
favorites[].keyInfo.bankName
string
Nome do banco do titular.
favorites[].keyInfo.bankCode
string
Código COMPE do banco (3 dígitos).
favorites[].keyInfo.ispb
string
Código ISPB (8 dígitos) da instituição.
pagination
object
Metadata de paginação por página.
pagination.total
number
Total absoluto de favoritos da conta.
pagination.page
number
Página atual (zero-indexed).
pagination.limit
number
Tamanho da página.
pagination.totalPages
number
Número total de páginas.
pagination.hasNextPage
boolean
true se existe próxima página.

json

{  "favorites": [    {      "id": "00000000-0000-0000-0000-0000000000f1",      "alias": null,      "key": "00000000-0000-0000-0000-000000000abc",      "keyType": "EVP",      "name": "Beltrano da Silva",      "createdAt": "2026-05-08T14:15:22.229Z",      "updatedAt": "2026-05-08T14:15:22.229Z",      "keyInfo": {        "id": "00000000-0000-0000-0000-0000000000f2",        "key": "00000000-0000-0000-0000-000000000abc",        "keyType": "EVP",        "name": "Beltrano da Silva",        "document": "***456789**",        "bankName": "BANCO EXEMPLO S.A.",        "bankCode": "999",        "ispb": "12345678"      }    }  ],  "pagination": {    "total": 1,    "page": 0,    "limit": 20,    "totalPages": 1,    "hasNextPage": false  }}

URL base:https://baas.staterpay.io

Listar favoritos Pix

Listar favoritos Pix

Path params

Query string

Headers

Exemplo de requisição

Resposta

On this page