Skip to main content
GET
List Refund Requests

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de consulta

limit
integer
predeterminado:10

Maximum number of items per page.

Rango requerido: 1 <= x <= 100
page
integer
predeterminado:1

Page number for pagination.

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

Sort direction: asc or desc.

Opciones disponibles:
asc,
desc
transaction_id
string

Filter by original Pix transaction ID (32 characters).

status
enum<string>

Filter by refund status.

Opciones disponibles:
OPEN,
CLOSED,
CANCELLED
requesting_participant
string

Filter by requesting participant ISPB (8 digits).

contested_participant
string

Filter by contested participant ISPB (8 digits).

infraction_id
string

Filter by related infraction report ID (UUID).

analysis_result
enum<string>

Filter by refund analysis result.

Opciones disponibles:
TOTALLY_ACCEPTED,
PARTIALLY_ACCEPTED,
REJECTED
refund_transaction_id
string

Filter by refund transaction ID (32 characters).

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 refund requests retrieved successfully.

items
object[]
page
integer
Ejemplo:

1

limit
integer
Ejemplo:

10