Saltar al contenido principal
POST
/
v1
/
transfers
/
{transfer_id}
/
refunds
Reembolsar una Transferencia Pix Recibida
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" }

Autorizaciones

​
Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

​
X-Account-Id
string
requerido

Identificador único de la Cuenta del Ledger Midaz (formato UUID).

​
X-Reason
enum<string>
requerido

Código de razón de reembolso. BE08 = Error Bancario, FR01 = Fraude, MD06 = Reembolso Solicitado por Cliente Final, SL02 = Error de PixWithdrawal/PixChange.

Opciones disponibles:
BE08,
FR01,
MD06,
SL02
​
X-Idempotency
string

Clave de idempotencia opcional para reintentos seguros. Si se omite, el servidor puede generar una automáticamente a partir del hash del cuerpo de la solicitud.

Consulte Reintentos e idempotencia para más detalles.

​
X-TTL
integer

Tiempo de vida en segundos para el caché de la clave de idempotencia. Define cuánto tiempo el sistema recuerda una solicitud procesada.

Consulte Reintentos e idempotencia para más detalles.

Parámetros de ruta

​
transfer_id
string
requerido

Identificador único de la transferencia Pix (formato UUID).

Cuerpo

application/json
​
amount
string

Monto del reembolso.

Ejemplo:

"100.00"

Respuesta

Instrucción de reembolso enviada exitosamente.

La respuesta incluye el header X-Idempotency-Replayed.

Si el valor es false, la transacción fue recién procesada. Si el valor es true, la respuesta es una repetición de una solicitud procesada anteriormente.

Consulte Reintentos e idempotencia para más detalles.

​
id
string

Identificador único del reembolso.

Ejemplo:

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

​
originalEndToEndId
string

ID E2E de la transferencia original.

Ejemplo:

"E123456789BR1234567890123456789"

​
returnEndToEndId
string

ID E2E de la transferencia de devolución.

Ejemplo:

"D123456789BR1234567890123456789"

​
amount
string

Monto del reembolso.

Ejemplo:

"100.00"

​
status
string

Estado del reembolso.

Ejemplo:

"COMPLETED"

​
reason
string

Código de razón del reembolso.

Ejemplo:

"FR01"

​
createdAt
string<date-time>
Ejemplo:

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