Saltar al contenido principal
POST
/
v1
/
dict
/
claims
/
{claim_id}
/
cancel
Cancelar una Reivindicación
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/claims/{claim_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '{}'
{
  "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"
}

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
X-Account-Id
string
requerido

Identificador único de la Cuenta del Ledger Midaz (formato UUID).

Parámetros de ruta

​
claim_id
string
requerido

Identificador único de la reivindicación (formato UUID).

Cuerpo

application/json

The body is of type object.

Respuesta

Reivindicación cancelada exitosamente.

​
id
string

UUID interno de la reivindicación.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

​
bacenClaimId
string

Identificador DICT de BACEN para esta reivindicación.

Ejemplo:

"cc91b1b0-8465-44b1-a760-15dd3717ea9b"

​
key
string

El valor de la clave Pix que se está reivindicando.

Ejemplo:

"+5561988887777"

​
keyType
string

Tipo de clave Pix.

Ejemplo:

"PHONE"

​
type
enum<string>

Tipo de reivindicación.

Opciones disponibles:
OWNERSHIP,
PORTABILITY
Ejemplo:

"OWNERSHIP"

​
status
enum<string>

Estado actual de la reivindicación.

Opciones disponibles:
OPEN,
WAITING_RESOLUTION,
CONFIRMED,
CANCELLED,
COMPLETED
Ejemplo:

"OPEN"

​
donorParticipant
string

ISPB del PSP donante.

Ejemplo:

"30306294"

​
resolutionPeriodEnd
string<date-time>

Fecha límite para respuesta del donante (D+7 desde la creación).

Ejemplo:

"2024-01-22T10:30:00Z"

​
completionPeriodEnd
string<date-time>

Fecha límite para completar la reivindicación (D+14 desde la creación).

Ejemplo:

"2024-01-29T10:30:00Z"

​
createdAt
string<date-time>

Marca de tiempo cuando se creó la reivindicación.

Ejemplo:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>

Marca de tiempo cuando se actualizó por última vez la reivindicación.

Ejemplo:

"2024-01-15T10:30:00Z"