Skip to main content
GET
List Refunds

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 consulta

page
integer
predeterminado:1

Page number for pagination.

Rango requerido: x >= 1
limit
integer
predeterminado:10

Maximum number of items per page.

Rango requerido: 1 <= x <= 100
sort_order
enum<string>
predeterminado:asc

Sort direction: asc or desc.

Opciones disponibles:
asc,
desc
end_to_end
string

Filter by the original Pix transfer end-to-end identifier.

status
enum<string>

Filter by the refund status (CREATED, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED).

Opciones disponibles:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
type
enum<string>

Filter by refund direction (CASHOUT or CASHIN).

Opciones disponibles:
CASHOUT,
CASHIN
modified_after
string

Filter by records modified after this timestamp (RFC3339 format: 2024-01-15T10:30:00Z).

modified_before
string

Filter by records modified before this timestamp (RFC3339 format: 2024-01-15T10:30:00Z).

Respuesta

List of refunds retrieved successfully.

items
object[]
limit
integer
Ejemplo:

10

page
integer
Ejemplo:

1

total
integer
Ejemplo:

42