Pular para o conteúdo principal
POST
/
v1
/
refunds
/
{refund_id}
/
unblock
Desbloquear uma Devolução Pix
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id}/unblock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "allowNotFoundUnblock": false
}
'
{
  "refund": {
    "id": "019c96a0-0c53-7a8d-8e29-67971d96d0e3",
    "originalEndToEndId": "E123456789BR1234567890123456789",
    "returnEndToEndId": "D123456789BR1234567890123456789",
    "amount": "100.00",
    "status": "COMPLETED",
    "reason": "FR01",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "btgStatus": "CONFIRMED",
  "message": "Reversão desbloqueada 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

​
refund_id
string
obrigatório

Identificador único da solicitação de reembolso (formato UUID).

Corpo

application/json
​
allowNotFoundUnblock
boolean
padrão:false

Habilita o caminho de resolução não-encontrado para reembolsos CASHOUT. Quando true e o BTG reporta a reversão como ausente (404), o reembolso é resolvido como FAILED (com reversão idempotente no Midaz e webhook ao cliente), em vez de retornar um erro do provedor.

Resposta

Desbloqueio da devolução processado com sucesso.

​
refund
object
obrigatório
​
btgStatus
string

Status obtido do BTG (para transparência).

Exemplo:

"CONFIRMED"

​
message
string

Contexto adicional sobre o resultado do desbloqueio.

Exemplo:

"Reversão desbloqueada com sucesso."