Skip to main content
POST
Unblock a Pix Refund

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Account-Id
string
obrigatório

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

Parâmetros de caminho

refund_id
string
obrigatório

Unique identifier of the refund request (UUID format).

Corpo

application/json
allowNotFoundUnblock
boolean
padrão:false

Opts into the not-found resolution path for CASHOUT refunds. When true and BTG reports the reversal as absent (404), the refund is resolved as FAILED (with idempotent Midaz revert and client webhook) instead of returning a provider error.

Resposta

Refund unblock processed successfully.

refund
object
obrigatório
btgStatus
string

Status retrieved from BTG (for transparency).

Exemplo:

"CONFIRMED"

message
string

Additional context about the unblock result.

Exemplo:

"Reversal successfully unblocked."