Skip to main content
GET
Get a Refund

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

Unique identifier of the Midaz Ledger Account (UUID format).

Parámetros de ruta

refund_id
string
requerido

Unique identifier of the refund request (UUID format).

Respuesta

Refund details retrieved successfully.

id
string

Refund unique identifier.

Ejemplo:

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

originalEndToEndId
string

Original transfer E2E ID.

Ejemplo:

"E123456789BR1234567890123456789"

returnEndToEndId
string

Return transfer E2E ID.

Ejemplo:

"D123456789BR1234567890123456789"

amount
string

Refund amount.

Ejemplo:

"100.00"

status
enum<string>

Refund status.

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

"COMPLETED"

type
enum<string>

Refund type.

Opciones disponibles:
CASHOUT,
CASHIN
Ejemplo:

"CASHOUT"

description
string

Optional refund description.

Ejemplo:

"Customer reported unauthorized transaction"

accountId
string

Account identifier associated with the refund.

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

Midaz ledger transaction and operation identifiers.

metadata
object

Custom key-value attributes associated with this refund. Maximum 50 keys, key max 100 chars, value max 2000 chars.