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>'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}"

headers = {
    "x-client-id": "<x-client-id>",
    "x-auth-token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-id': '<x-client-id>', 'x-auth-token': '<api-key>'}
};

fetch('https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-auth-token: <api-key>",
    "x-client-id: <x-client-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-id", "<x-client-id>")
	req.Header.Add("x-auth-token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}")
  .header("x-client-id", "<x-client-id>")
  .header("x-auth-token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<x-client-id>'
request["x-auth-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

GET

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>'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}"

headers = {
    "x-client-id": "<x-client-id>",
    "x-auth-token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-id': '<x-client-id>', 'x-auth-token': '<api-key>'}
};

fetch('https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-auth-token: <api-key>",
    "x-client-id: <x-client-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-id", "<x-client-id>")
	req.Header.Add("x-auth-token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}")
  .header("x-client-id", "<x-client-id>")
  .header("x-auth-token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment/refunds/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<x-client-id>'
request["x-auth-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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

string

required

The ID of the refund to retrieve

Example:

"RF1234567890123456789"

Response

200 - application/json

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.

INITIATED: The refund has been initiated.
PROCESSING: The refund is being processed.
SUCCEEDED: The refund was successfully completed.
FAILED: The refund attempt failed.
REVERSAL_INITIATED: The reversal of the refund has been initiated.
REVERSAL_PROCESSING: The reversal of the refund is currently being processed.
REVERSAL_SUCCEEDED: The reversal of the refund was successfully completed.

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.

Show child attributes

Example:

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

Create refund Get list of settlements