Pular para o conteúdo principal
POST
/
v1
/
transfers
/
{transfer_id}
/
unblock
Desbloquear uma Transferência 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": "Transação desbloqueada e concluída com sucesso"
}

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"