Skip to main content
GET
List all refunds

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

x-client-id
string
required

The API client id generated by UQPAY

Query Parameters

page_size
integer
required

The maximum number of items to return per page. This number can be between 1 - 100

Required range: 1 <= x <= 100
Example:

10

page_number
integer
required

The page number to retrieve the next set of items. The number has to be greater than 1.

Required range: x >= 1
Example:

1

start_time
string

Start time of Transaction. Default time range is 1 months.

Example:

"2024-03-01T00:00:00+08:00"

end_time
string

End time of Transaction. Maximum time range of 3 months.

Example:

"2024-03-01T00:00:00+08:00"

payment_intent_id
string

The ID of the payment intent to get refunds for

merchant_order_id
string

The merchant reference id created in merchant's system that corresponds to this PaymentIntent.

Response

200 - application/json

List of refunds retrieved successfully

total_pages
integer

The total pages of available items.

Example:

10

total_items
integer

The total counts of available items.

Example:

105

data
object[]