Retrieve Deposit

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

import requests

url = "https://api-sandbox.uqpaytech.com/api/v1/deposit/{id}"

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/deposit/{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/v1/deposit/{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>"
  ],
]);

$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/deposit/{id}"

	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/deposit/{id}")
  .header("x-auth-token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v1/deposit/{id}")

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

{
  "deposit_id": "72970a7c-7921-431c-b95f-3438724ba16f",
  "short_reference_id": "P220406-LLCVLRM",
  "amount": "10000",
  "currency": "USD",
  "deposit_fee": "1",
  "deposit_status": "COMPLETED",
  "complete_time": "2024-03-01T00:00:00+08:00",
  "receiver_account_number": "12345678",
  "sender": {
    "sender_name": "UQPAY SG",
    "sender_country": "SG",
    "sender_account_number": "12345678",
    "sender_swift_code": "WELGBE22"
  },
  "deposit_reference": "test reference",
  "create_time": "2024-03-01T00:00:00+08:00"
}

GET

deposit

{id}

Retrieve Deposit

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

import requests

url = "https://api-sandbox.uqpaytech.com/api/v1/deposit/{id}"

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/deposit/{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/v1/deposit/{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>"
  ],
]);

$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/deposit/{id}"

	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/deposit/{id}")
  .header("x-auth-token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v1/deposit/{id}")

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

{
  "deposit_id": "72970a7c-7921-431c-b95f-3438724ba16f",
  "short_reference_id": "P220406-LLCVLRM",
  "amount": "10000",
  "currency": "USD",
  "deposit_fee": "1",
  "deposit_status": "COMPLETED",
  "complete_time": "2024-03-01T00:00:00+08:00",
  "receiver_account_number": "12345678",
  "sender": {
    "sender_name": "UQPAY SG",
    "sender_country": "SG",
    "sender_account_number": "12345678",
    "sender_swift_code": "WELGBE22"
  },
  "deposit_reference": "test reference",
  "create_time": "2024-03-01T00:00:00+08:00"
}

授权

x-auth-token

string

header

必填

由 UQPay 提供的登录 API Token。

请求头

x-on-behalf-of

string

指定代表哪个子账户发起请求。应设为 account_id，可通过查询关联账户列表获取。如果省略或留空，请求将使用主账户执行。更多信息参见关联账户。

路径参数

string<uuid>

必填

资源的通用唯一标识符（UUID v4）。

示例:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

响应

200 - application/json

OK —— 成功获取账户详情。

deposit_id

string

必填

充值 ID。

示例:

"72970a7c-7921-431c-b95f-3438724ba16f"

short_reference_id

string

必填

系统生成的用于标识该实体的编号。

示例:

"P220406-LLCVLRM"

amount

string

必填

充值的金额。表示扣除任何手续费之前的总额。

示例:

"10000"

currency

string

必填

受益人银行账户中持有资金的币种。三位字母 ISO 4217 币种代码。

Required string length: 3

示例:

"USD"

deposit_fee

string

必填

充值的手续费。

示例:

"1"

deposit_status

enum<string>

必填

充值的状态。

可用选项:

PENDING,

COMPLETED,

FAILED

示例:

"COMPLETED"

complete_time

string<date/time>

必填

请求成功处理并标记为 COMPLETED 时的时间戳。

示例:

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

receiver_account_number

string

必填

账号，多用于非欧洲国家/地区，account_number 与 iban 须填写其一。

仅允许英文字母（大小写）和数字；不允许使用短横线或其他特殊字符。

Maximum string length: 60

Pattern: ^[a-zA-Z0-9]*$

示例:

"12345678"

sender

object

必填

发起该充值的汇款方信息。

Show child attributes

deposit_reference

string

充值的附言。

示例:

"test reference"

create_time

string<date/time>

记录在系统中创建时的时间戳。时间戳遵循 ISO 8601 标准。

示例:

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

List deposits List virtual accounts