Skip to main content
GET
/
v2
/
payment
/
refunds
/
{id}
Retrieve a refund
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id} \
  --header 'x-auth-token: <api-key>' \
  --header 'x-client-id: <x-client-id>'
{
  "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"
  }
}

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

Path Parameters

​
id
string
required

The ID of the refund to retrieve

Example:

"RF1234567890123456789"

Response

Refund details retrieved successfully

​
payment_refund_id
string

The unique identifier for the refund

Example:

"RF123456789"

​
payment_attempt_id
string

The ID of the payment attempt that was refunded

Example:

"PA123456789"

​
amount
string

The amount refunded

Example:

"10.01"

​
currency
string<iso-4217>

The three-letter currency code (ISO 4217)

Example:

"USD"

​
refund_status
enum<string>

The current status of the refund

Available options:
INITIATED,
PROCESSING,
SUCCEEDED,
FAILED,
REVERSAL_INITIATED,
REVERSAL_PROCESSING,
REVERSAL_SUCCEEDED
Example:

"SUCCEEDED"

​
create_time
string<date/time>

The time at which this payment refund was created.

Example:

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

​
update_time
string<date/time>

Last time at which this payment refund was updated or operated on.

Example:

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

​
reason
string

The reason for the refund

Maximum string length: 100
Example:

"Order 1234 has been returned"

​
metadata
object

Additional metadata associated with the refund. User-defined key-value pairs.

Example:
{
  "customer_id": "cust_12345",
  "order_id": "order_6789"
}