Skip to main content
GET
List Refund Requests

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

limit
integer<int64>
default:10

Maximum number of items per page (default: 10, range: 1-100)

page
integer<int64>
default:1

Page number for pagination (default: 1, minimum: 1)

sort_order
string
default:asc

Sort direction for results: asc or desc

transaction_id
string

Filter by original Pix transaction ID (32 characters)

status
string[]

Filter by refund status (comma-separated for OR match): OPEN, CLOSED, CANCELLED

requesting_participant
string

Filter by requesting participant ISPB (8 uppercase alphanumeric characters)

contested_participant
string

Filter by contested participant ISPB (8 uppercase alphanumeric characters)

infraction_id
string<uuid>

Filter by related infraction report ID (UUID)

analysis_result
string

Filter by refund analysis result: TOTALLY_ACCEPTED, PARTIALLY_ACCEPTED, REJECTED

refund_transaction_id
string

Filter by refund transaction ID (32 characters)

modified_after
string

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

modified_before
string

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

Response

OK

items
object[]
required

Refund requests on the current page

limit
integer<int64>
required

Number of items per page

Example:

10

page
integer<int64>
required

Current page number

Example:

1

total
integer<int64>
required

Total number of refund requests matching the filters

Example:

85