Skip to main content
POST
/
v1
/
transfers
/
{transfer_id}
/
unblock
Unblock a Pix Transfer
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"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Account-Id
string
required

Unique identifier of the Midaz Ledger Account (UUID format).

Path Parameters

​
transfer_id
string
required

Unique identifier of the Pix transfer (UUID format).

Body

application/json
​
allowNotFoundUnblock
boolean
default:false

Opts into the not-found resolution path. When true and BTG returns HTTP 404 for the transfer's EndToEndID, the unblock flow reverts the Midaz hold (if any) and marks the cashout as FAILED with failedReason=BTG_NOT_FOUND instead of returning a provider error. Only applies to CASHOUT transfers in PENDING or PROCESSING status.

Response

Transfer unblock processed successfully.

​
transfer
object
required
​
btgStatus
string

Status retrieved from BTG (for transparency).

Example:

"CONFIRMED"

​
message
string

Additional context about the unblock result.

Example:

"Transaction successfully unblocked and completed"