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": "019c96a0-0c53-7a8d-8e29-67971d96d0e3",
  "originalEndToEndId": "E123456789BR1234567890123456789",
  "returnEndToEndId": "D123456789BR1234567890123456789",
  "amount": "100.00",
  "status": "COMPLETED",
  "reason": "FR01",
  "createdAt": "2024-01-15T10:30:00Z"
}

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).

​
X-Reason
enum<string>
obrigatório

Código do motivo do estorno. BE08 = Erro Bancário, FR01 = Fraude, MD06 = Estorno Solicitado pelo Cliente Final, SL02 = Erro de PixSaque/PixTroco.

Opções disponíveis:
BE08,
FR01,
MD06,
SL02
​
X-Idempotency
string

Chave de idempotência opcional para repetições seguras. Reutilize o mesmo valor apenas ao repetir a mesma operação após um resultado desconhecido.

Consulte Repetições e idempotência para mais detalhes.

​
X-TTL
integer

Tempo de vida (time-to-live), em segundos, para o cache da chave de idempotência. Define por quanto tempo o sistema lembra de uma requisição processada.

Consulte Repetições e idempotência para mais detalhes.

Parâmetros de caminho

​
transfer_id
string
obrigatório

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

Corpo

application/json
​
amount
string
obrigatório

Valor total do reembolso. Quando operations é fornecido, este valor deve ser igual à soma de todos os valores das operações.

Exemplo:

"100.50"

​
description
string

Descrição opcional para o reembolso.

Maximum string length: 140
Exemplo:

"Cliente relatou transação não autorizada"

​
metadata
object

Atributos personalizados de chave-valor para este reembolso. Máximo de 50 chaves, chave com no máximo 100 caracteres, valor com no máximo 2000 caracteres.

​
operations
object[]

Operações explícitas de débito por conta para reembolsos distribuídos parciais. Quando presente, cada operação especifica o accountAlias e o valor a debitar, e a soma de todos os valores das operações deve ser igual ao amount total do reembolso. Quando ausente, o fluxo de reembolso existente é usado (reembolso simples ou integral com inversão de tarifa).

Required array length: 1 - 50 elements

Resposta

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

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a transação acabou de ser processada. Se o valor for true, a resposta é uma reprodução de uma requisição processada anteriormente.

Consulte Retentativas e idempotência para mais detalhes.

​
id
string

Identificador único do reembolso.

Exemplo:

"019c96a0-0c53-7a8d-8e29-67971d96d0e3"

​
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 do reembolso.

Exemplo:

"100.00"

​
status
string

Status do reembolso.

Exemplo:

"COMPLETED"

​
reason
string

Código do motivo do reembolso.

Exemplo:

"FR01"

​
createdAt
string<date-time>
Exemplo:

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