Saltar al contenido principal
POST
Reembolsar una transferencia Pix recibida

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 de Midaz (formato UUID).

X-Reason
enum<string>
requerido

Código del motivo de la devolución. BE08 = Error bancario, FR01 = Fraude, MD06 = Devolución solicitada por el cliente final, SL02 = Error de PixWithdrawal/PixChange.

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

Clave de idempotencia opcional para reintentos seguros. Reutiliza el mismo valor solo cuando reintentas la misma operación tras un resultado desconocido.

Consulta Reintentos e idempotencia para más detalles.

X-TTL
integer

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

Consulta 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
requerido

Monto total de la devolución. Cuando se proporciona operations, este debe ser igual a la suma de todos los montos de las operaciones.

Ejemplo:

"100.50"

description
string

Descripción opcional para la devolución.

Maximum string length: 140
Ejemplo:

"Customer reported unauthorized transaction"

metadata
object

Atributos personalizados de clave-valor para esta devolución. Máximo 50 claves, clave de máximo 100 caracteres, valor de máximo 2000 caracteres.

operations
object[]

Operaciones de débito explícitas por cuenta para devoluciones distribuidas parciales. Cuando están presentes, cada operación especifica el accountAlias y el monto a debitar, y la suma de todos los montos de las operaciones debe ser igual al amount total de la devolución. Cuando están ausentes, se utiliza el flujo de devolución existente (devolución simple o total con inversión de tarifa).

Required array length: 1 - 50 elements

Respuesta

Instrucción de reembolso enviada correctamente.

La respuesta incluye el encabezado X-Idempotency-Replayed.

Si el valor es false, la transacción se acaba de procesar. Si el valor es true, la respuesta es una repetición de una solicitud procesada anteriormente.

Consulta Reintentos e idempotencia para obtener más detalles.

id
string

Identificador único de la devolución.

Ejemplo:

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

originalEndToEndId
string

ID E2E de la transferencia original.

Ejemplo:

"E123456789BR1234567890123456789"

returnEndToEndId
string

ID E2E de la transferencia de retorno.

Ejemplo:

"D123456789BR1234567890123456789"

amount
string

Monto de la devolución.

Ejemplo:

"100.00"

status
enum<string>

Estado de la devolución.

Opciones disponibles:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
Ejemplo:

"COMPLETED"

type
enum<string>

Tipo de devolución.

Opciones disponibles:
CASHOUT,
CASHIN
Ejemplo:

"CASHOUT"

description
string

Descripción opcional de la devolución.

Ejemplo:

"Customer reported unauthorized transaction"

accountId
string

Identificador de la cuenta asociada con la devolución.

Ejemplo:

"01989f9e-6508-79f8-9540-835be49fbd0d"

createdAt
string<date-time>
Ejemplo:

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

updatedAt
string<date-time>
Ejemplo:

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

ledger
object

Identificadores de transacción y operación del ledger de Midaz.

metadata
object

Atributos personalizados de clave-valor asociados con esta devolución. Máximo 50 claves, clave de máximo 100 caracteres, valor de máximo 2000 caracteres.