v1
latestOpenAPI 3.0.22026-07-26123510445.2 KBPayment Refunds
List all refunds
Retrieve a list of refunds with optional filtering
get/v2/payment/refunds
Query parameters
page_sizeinteger required
Example:10
The maximum number of items to return per page. This number can be between 1 - 100
page_numberinteger required
Example:1
The page number to retrieve the next set of items. The number has to be greater than 1.
start_timestring
Example:2024-03-01T00:00:00+08:00
Exclusive start time used to filter by create_time. ISO 8601 format.
end_timestring
Example:2024-03-02T00:00:00+08:00
Exclusive end time used to filter by create_time. ISO 8601 format.
payment_intent_idstring
The ID of the payment intent to get refunds for
merchant_order_idstring
The merchant reference id created in merchant's system that corresponds to this PaymentIntent.
Headers
x-client-idstring required
The API client id generated by UQPAY
Response
List of refunds retrieved successfully
Example response
{
"total_pages": 10,
"total_items": 105,
"data": [
{
"payment_refund_id": "RF123456789",
"payment_attempt_id": "PA123456789",
"amount": "10.01",
"currency": "USD",
"refund_status": "SUCCEEDED",
"create_time": "2024-03-01T00:00:00+08:00",
"update_time": "2024-03-01T00:00:00+08:00",
"reason": "Order 1234 has been returned",
"metadata": {
"customer_id": "cust_12345",
"order_id": "order_6789"
}
}
]
}