Skip to main content
GET
List refund payments

Authorizations

Authorization
string
header
required

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

Headers

Content-Type
string

Content-Type must be set to application/json.

Path Parameters

businessId
string
required

The UUID of the business to fetch refund payments for.

Query Parameters

external_id
string

Filter refund payments by external ID.

completed_at_start
string<date-time>

Filter refund payments by completion date. Payments completed on or after this date will be included. ISO 8601 date format.

completed_at_end
string<date-time>

Filter refund payments by completion date. Payments completed on or before this date will be included. ISO 8601 date format.

method
string

Filter refund payments by payment method.

processor
string

Filter refund payments by processor.

min_amount
integer<int64>

Filter refund payments by minimum amount. Only payments with amounts greater than or equal to this value will be included.

Required range: x >= 0
max_amount
integer<int64>

Filter refund payments by maximum amount. Only payments with amounts less than or equal to this value will be included.

Required range: x >= 0
included_in_payout
boolean

Filter refund payments by whether they are included in a payout.

is_matched
boolean

Filter refund payments by whether they are matched to a bank transaction.

reference_number
string

Filter by exact reference number match. Returns only records with this exact reference number.

reference_numbers
string

Comma-separated list of reference numbers to filter refund payments by.

Response

List of refund payments.

data
object[]
required
meta
object

Request metadata. Present on paginated list responses.