Saltar al contenido principal
GET
/
v1
/
dict
/
claims
Listar Reivindicaciones
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/claims \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "bacenClaimId": "cc91b1b0-8465-44b1-a760-15dd3717ea9b",
      "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
}

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de consulta

​
limit
integer
predeterminado:10

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

Rango requerido: 1 <= x <= 100
​
page
integer
predeterminado:1

Número de página para paginación.

Rango requerido: x >= 1
​
type
enum<string>

Filtrar por tipo de reivindicación.

Opciones disponibles:
OWNERSHIP,
PORTABILITY
​
status
enum<string>

Filtrar por estado de reivindicación.

Opciones disponibles:
OPEN,
WAITING_RESOLUTION,
CONFIRMED,
CANCELLED,
COMPLETED
​
key_value
string

Filtrar por valor de clave Pix.

​
sort_order
enum<string>
predeterminado:asc

Dirección de ordenamiento: asc o desc.

Opciones disponibles:
asc,
desc
​
bacen_claim_id
string

Filtrar por ID de reivindicación BACEN (UUID).

Respuesta

Lista de reivindicaciones obtenida exitosamente.

​
items
object[]
requerido
​
page
integer
requerido
Ejemplo:

1

​
limit
integer
requerido
Ejemplo:

10