Saltar al contenido principal
POST
/
v1
/
transfers
/
{transfer_id}
/
unblock
Desbloquear una transferencia Pix
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transfers/{transfer_id}/unblock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "allowNotFoundUnblock": false
}
'
{
  "transfer": {
    "id": "019c96a0-0c21-71f9-a487-66a1258278a1",
    "endToEndId": "E123456789BR1234567890123456789",
    "amount": "100.00",
    "status": "COMPLETED",
    "type": "CASHOUT",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  },
  "btgStatus": "CONFIRMED",
  "message": "Transaction successfully unblocked and completed"
}

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

​
transfer_id
string
requerido

Identificador único de la transferencia Pix (formato UUID).

Cuerpo

application/json
​
allowNotFoundUnblock
boolean
predeterminado:false

Habilita la vía de resolución de no encontrado. Cuando es true y BTG devuelve HTTP 404 para el EndToEndID de la transferencia, el flujo de desbloqueo revierte la retención de Midaz (si la hubiera) y marca el cash-out como FAILED con failedReason=BTG_NOT_FOUND en lugar de devolver un error del proveedor. Solo se aplica a transferencias CASHOUT en estado PENDING o PROCESSING.

Respuesta

Desbloqueo de la transferencia procesado correctamente.

​
transfer
object
requerido
​
btgStatus
string

Estado recuperado de BTG (por transparencia).

Ejemplo:

"CONFIRMED"

​
message
string

Contexto adicional sobre el resultado del desbloqueo.

Ejemplo:

"Transaction successfully unblocked and completed"