Skip to main content
GET
List Refunds

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

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

Parâmetros de consulta

​
page
integer
padrão:1

Page number for pagination.

Intervalo obrigatório: x >= 1
​
limit
integer
padrão:10

Maximum number of items per page.

Intervalo obrigatório: 1 <= x <= 100
​
sort_order
enum<string>
padrão:asc

Sort direction: asc or desc.

Opções disponíveis:
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).

Opções disponíveis:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
​
type
enum<string>

Filter by refund direction (CASHOUT or CASHIN).

Opções disponíveis:
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).

Resposta

List of refunds retrieved successfully.

​
items
object[]
​
limit
integer
Exemplo:

10

​
page
integer
Exemplo:

1

​
total
integer
Exemplo:

42