Skip to main content
GET
List refund requests

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1

Requested page, starting at 1.

Required range: x >= 1
pageSize
integer
default:10

Number of items per page (maximum 100).

Required range: 1 <= x <= 100
status
enum<string>

Filters by refund request status.

Available options:
pending,
approved,
rejected,
processed,
canceled
refundChannel
enum<string>

Filters by the channel that executed the refund.

Available options:
api,
manual_pending,
manual_done
startDate
string<date-time>

Considers only requests opened on or after this date.

endDate
string<date-time>

Considers only requests opened on or before this date.

Searches by the payer's name or email address, or by the name of a product in the transaction.

Minimum string length: 1

Response

Page of refund requests.

Page of refund requests.

success
boolean
required

Always true in a successful response.

data
object[]
required
pagination
object
required