Access Token

curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/connect/token \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'

import requests

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

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

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

print(response.text)

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

fetch('https://api-sandbox.uqpaytech.com/api/v1/connect/token', 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/connect/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>",
    "x-client-id: <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/connect/token"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v1/connect/token")
  .header("x-api-key", "<api-key>")
  .header("x-client-id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "auth_token": "2YotnFZFEjr1zCsicMWpAA2YotnFZFEjr1zCsicMWpAA2YotnFZFEjr1zCsicMWpAA2YotnFZFEjr1zCsicMWpAA",
  "expired_at": 1757449854
}

Authentication

Access Token

Request an access token by specifying your x-client-id and x-api-key in the HTTP request header. The returned auth_token is required for all other API endpoints and must be passed in the x-auth-token header prefixed with Bearer — for example, x-auth-token: Bearer <YOUR_TOKEN_HERE>. The Bearer prefix is required across all business lines.

The access token can be used multiple times for all other API endpoints until it expires. Rely on expired_at for the accurate token expiration time.

auth_token is valid for 30 minutes in Production.

Token concurrency by business line

Whether a newly issued token invalidates the previous one depends on the business line:

Multiple tokens may coexist (newly issued tokens do not invalidate previous ones) — Account Center, Card Issuance.
Single active token only (a newly issued token immediately invalidates the previous one) — Global Account, Global Acquiring, Stablecoin Account.

For single-active-token business lines, avoid requesting new tokens from multiple processes concurrently — running processes may start receiving authentication errors once another process refreshes the token.

POST

connect

token

Access Token

curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/connect/token \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'

import requests

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

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

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

print(response.text)

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

fetch('https://api-sandbox.uqpaytech.com/api/v1/connect/token', 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/connect/token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>",
    "x-client-id: <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/connect/token"

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v1/connect/token")
  .header("x-api-key", "<api-key>")
  .header("x-client-id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "auth_token": "2YotnFZFEjr1zCsicMWpAA2YotnFZFEjr1zCsicMWpAA2YotnFZFEjr1zCsicMWpAA2YotnFZFEjr1zCsicMWpAA",
  "expired_at": 1757449854
}

Authorizations

x-api-key

string

header

required

The API key generated by UQPAY.

x-client-id

string

header

required

The API client id generated by UQPAY.

Response

200 - application/json

Successfully.

auth_token

string

required

Returned authentication token. Clients must store this securely and destroy it when it is no longer needed.

Example:

"2YotnFZFEjr1zCsicMWpAA2YotnFZFEjr1zCsicMWpAA2YotnFZFEjr1zCsicMWpAA2YotnFZFEjr1zCsicMWpAA"

expired_at

integer

required

Expiration time represented as a Unix timestamp in second-level precision. Indicates the point in time after which the token becomes invalid.

Example:

1757449854

Create sub account