List Transfers - UQPAY Developer Docs

List Transfers

curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/transfer \
  --header 'x-auth-token: <api-key>'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v1/transfer"

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

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

print(response.text)

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

fetch('https://api-sandbox.uqpaytech.com/api/v1/transfer', 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/v1/transfer",
  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>"
  ],
]);

$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/v1/transfer"

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

	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/v1/transfer")
  .header("x-auth-token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v1/transfer")

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

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

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

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "transfer_id": "94d48e21-0a99-480c-b1b7-2e6d34e6eb67",
      "reference_id": "P220406-LLCVLRM",
      "short_reference_id": "P220406-LLCVLRM",
      "source_account_name": "UQPAY SOURCE",
      "destination_account_name": "UQPAY DEST",
      "transfer_currency": "USD",
      "transfer_amount": "1000",
      "transfer_status": "pending",
      "create_time": "2024-04-02T10:27:08+08:00",
      "complete_time": "0001-01-01T00:00:00Z",
      "created_by": "System"
    }
  ]
}

GET

transfer

List Transfers

curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/transfer \
  --header 'x-auth-token: <api-key>'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v1/transfer"

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

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

print(response.text)

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

fetch('https://api-sandbox.uqpaytech.com/api/v1/transfer', 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/v1/transfer",
  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>"
  ],
]);

$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/v1/transfer"

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

	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/v1/transfer")
  .header("x-auth-token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v1/transfer")

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

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

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

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "transfer_id": "94d48e21-0a99-480c-b1b7-2e6d34e6eb67",
      "reference_id": "P220406-LLCVLRM",
      "short_reference_id": "P220406-LLCVLRM",
      "source_account_name": "UQPAY SOURCE",
      "destination_account_name": "UQPAY DEST",
      "transfer_currency": "USD",
      "transfer_amount": "1000",
      "transfer_status": "pending",
      "create_time": "2024-04-02T10:27:08+08:00",
      "complete_time": "0001-01-01T00:00:00Z",
      "created_by": "System"
    }
  ]
}

Authorizations

x-auth-token

string

header

required

The API token for login provided by UQPay.

Query Parameters

page_size

integer

required

The maximum number of items to return per page. Must be between 10 and 100, inclusive.

Required range: 1 <= x <= 100

Example:

10

page_number

integer

required

The page number to retrieve a specific set of items. Must be 1 or greater.

Required range: x >= 1

Example:

1

start_time

string

The start time of created_time in ISO8601 format (inclusive).

Example:

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

end_time

string

The end time of created_time in ISO8601 format (inclusive).

Example:

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

transfer_status

enum<string>

Indicates the current status of the transfer transaction. Valid values are:

completed: indicates that the transfer transaction has been successfully completed.
failed: indicates that the transfer transaction has failed.

Available options:

completed,

failed

Example:

"completed"

currency

string

Currency code ISO_4217.

Example:

"USD,SGD"

Response

200 - application/json

OK - Successfully retrieved a list of transfers.

total_pages

integer

The total number of pages of available items.

Example:

10

total_items

integer

The total counts of available items.

Example:

105

data

object[]

List of transfer records.

Show child attributes

Create transfer