Pular para o conteúdo principal
GET
/
v1
/
dict
/
claims
Listar Reivindicações
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/claims \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "019c96a0-0c3e-77b5-8321-4807058a67bb",
      "bacenClaimId": "019c96a0-0d16-7184-ad7f-38545eeb671c",
      "key": "+5561988887777",
      "keyType": "PHONE",
      "type": "OWNERSHIP",
      "status": "OPEN",
      "donorParticipant": "30306294",
      "resolutionPeriodEnd": "2024-01-22T10:30:00Z",
      "completionPeriodEnd": "2024-01-29T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "page": 1,
  "limit": 10
}

Autorizações

​
Authorization
string
header
obrigatório

Header de autenticação Bearer no formato Bearer <token>, onde <token> é o seu token de acesso JWT.

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 por 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 por 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