Saltar al contenido principal
POST
/
v1
/
refunds
/
{refund_id}
/
unblock
Desbloquear un reembolso Pix
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id}/unblock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "allowNotFoundUnblock": false
}
'
{
  "refund": {
    "id": "019c96a0-0c53-7a8d-8e29-67971d96d0e3",
    "originalEndToEndId": "E123456789BR1234567890123456789",
    "returnEndToEndId": "D123456789BR1234567890123456789",
    "amount": "100.00",
    "status": "COMPLETED",
    "reason": "FR01",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "btgStatus": "CONFIRMED",
  "message": "Reversal successfully unblocked."
}

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 de Midaz (formato UUID).

Parámetros de ruta

​
refund_id
string
requerido

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

Cuerpo

application/json
​
allowNotFoundUnblock
boolean
predeterminado:false

Habilita la vía de resolución de no encontrado para devoluciones CASHOUT. Cuando es true y BTG reporta la reversión como ausente (404), la devolución se resuelve como FAILED (con reversión idempotente de Midaz y webhook al cliente) en lugar de devolver un error del proveedor.

Respuesta

Desbloqueo del reembolso procesado correctamente.

​
refund
object
requerido
​
btgStatus
string

Estado recuperado de BTG (por transparencia).

Ejemplo:

"CONFIRMED"

​
message
string

Contexto adicional sobre el resultado del desbloqueo.

Ejemplo:

"Reversal successfully unblocked."