Skip to main content
POST
Desbloquear uma Transferência Pix

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

Identificador único da Conta do Ledger Midaz (formato UUID).

Parâmetros de caminho

transfer_id
string
obrigatório

Identificador único da transferência Pix (formato UUID).

Corpo

application/json
allowNotFoundUnblock
boolean
padrão:false

Habilita o caminho de resolução não-encontrado. Quando true e o BTG retorna HTTP 404 para o EndToEndID da transferência, o fluxo de desbloqueio reverte o bloqueio (hold) no Midaz (se houver) e marca o cashout como FAILED com failedReason=BTG_NOT_FOUND, em vez de retornar um erro do provedor. Aplica-se apenas a transferências CASHOUT no status PENDING ou PROCESSING.

Resposta

Desbloqueio da transferência processado com sucesso.

transfer
object
obrigatório
btgStatus
string

Status obtido do BTG (para transparência).

Exemplo:

"CONFIRMED"

message
string

Contexto adicional sobre o resultado do desbloqueio.

Exemplo:

"Transação desbloqueada e concluída com sucesso"