Skip to main content
GET
Listar reivindicações

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

limit
integer
padrão:10

Número máximo de itens por página.

Intervalo obrigatório: 1 <= x <= 100
page
integer
padrão:1

Número da página para paginação.

Intervalo obrigatório: x >= 1
type
enum<string>

Filtrar por tipo de reivindicação.

Opções disponíveis:
OWNERSHIP,
PORTABILITY
status
enum<string>

Filtrar por status da reivindicação.

Opções disponíveis:
OPEN,
WAITING_RESOLUTION,
CONFIRMED,
CANCELLED,
COMPLETED
key_value
string

Filtrar pelo valor da chave Pix.

sort_order
enum<string>
padrão:asc

Direção da ordenação: asc ou desc.

Opções disponíveis:
asc,
desc
bacen_claim_id
string

Filtrar pelo ID da reivindicação no BACEN (UUID).

Resposta

Lista de reivindicações recuperada com sucesso.

items
object[]
obrigatório
page
integer
obrigatório
Exemplo:

1

limit
integer
obrigatório
Exemplo:

10