Skip to main content
GET
List Refunds

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id
string
required

Account ID (UUID format)

Query Parameters

page
string

Page number for pagination (default: 1)

limit
string

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

sort_order
string

Sort direction for results: asc or desc

end_to_end
string

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

status
string

Filter by refund status; comma-separated for multiple (OR-matched), e.g. PENDING,COMPLETED. Allowed: CREATED, PENDING, PROCESSING, COMPLETED, REJECTED, FAILED, CANCELLED

type
string

Filter by refund direction (CASHOUT or CASHIN)

modified_after
string

Filter by refunds modified after this timestamp (RFC3339)

modified_before
string

Filter by refunds modified before this timestamp (RFC3339)

Response

OK

items
object[]
required
limit
integer<int64>
required
Example:

10

page
integer<int64>
required
Example:

1

total
integer<int64>
required
Example:

42