Pular para o conteúdo principal
POST
/
v1
/
transfers
/
{transfer_id}
/
refunds
Devolver uma Transferência PIX Recebida
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transfers/{transfer_id}/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Reason: <x-reason>' \
  --data '
{
  "amount": "100.00"
}
'
{
  "id": "550e8400-e29b-41d4-a716-44665544rf01",
  "originalEndToEndId": "E123456789BR1234567890123456789",
  "returnEndToEndId": "D123456789BR1234567890123456789",
  "amount": "100.00",
  "status": "COMPLETED",
  "reason": "FR01",
  "createdAt": "2024-01-15T10:30:00Z"
}

Autorizações

​
Authorization
string
header
obrigatório

Header de autenticação Bearer no formato Bearer <token>, onde <token> é o seu token de acesso JWT.

Cabeçalhos

​
X-Account-Id
string
obrigatório

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

​
X-Reason
enum<string>
obrigatório

Código do motivo da devolução. BE08 = Erro Bancário, FR01 = Fraude, MD06 = Devolução Solicitada pelo Cliente Final, SL02 = Erro de PixSaque/PixTroco.

Opções disponíveis:
BE08,
FR01,
MD06,
SL02

Parâmetros de caminho

​
transfer_id
string
obrigatório

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

Corpo

application/json
​
amount
string

Valor da devolução.

Exemplo:

"100.00"

Resposta

Instrução de devolução enviada com sucesso.

​
id
string

Identificador único da devolução.

Exemplo:

"550e8400-e29b-41d4-a716-44665544rf01"

​
originalEndToEndId
string

ID E2E da transferência original.

Exemplo:

"E123456789BR1234567890123456789"

​
returnEndToEndId
string

ID E2E da transferência de devolução.

Exemplo:

"D123456789BR1234567890123456789"

​
amount
string

Valor da devolução.

Exemplo:

"100.00"

​
status
string

Status da devolução.

Exemplo:

"COMPLETED"

​
reason
string

Código do motivo da devolução.

Exemplo:

"FR01"

​
createdAt
string<date-time>
Exemplo:

"2024-01-15T10:30:00Z"