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",
"deposit_method": "LOCAL",
"complete_time": "2024-03-01T00:00:00+08:00",
"receiver_account_number": "12345678",
"sender": {
"sender_type": "INDIVIDUAL",
"name_type": "NAMED",
"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"
}Deposits
Retrieve Deposit
使用给定的 deposit ID 获取某笔充值的详情。
GET
/
v1
/
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",
"deposit_method": "LOCAL",
"complete_time": "2024-03-01T00:00:00+08:00",
"receiver_account_number": "12345678",
"sender": {
"sender_type": "INDIVIDUAL",
"name_type": "NAMED",
"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"
}授权
由 UQPAY 提供的登录 API Token。
路径参数
资源的通用唯一标识符(UUID v4)。
示例:
"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
响应
200 - application/json
OK —— 成功获取账户详情。
充值 ID。
示例:
"72970a7c-7921-431c-b95f-3438724ba16f"
系统生成的用于标识该实体的编号。
示例:
"P220406-LLCVLRM"
充值的金额。表示扣除任何手续费之前的总额。
示例:
"10000"
充值的手续费。
示例:
"1"
充值的状态。
可用选项:
PENDING, COMPLETED, FAILED 示例:
"COMPLETED"
入账资金所使用的支付通道。
可用选项:
LOCAL, SWIFT, UQPAY_TRANSFER, 请求成功处理并标记为 COMPLETED 时的时间戳。请求仍在处理中时返回 null。
示例:
"2024-03-01T00:00:00+08:00"
账号,多用于非欧洲国家/地区,account_number 与 iban 须填写其一。
仅允许英文字母(大小写)和数字;不允许使用短横线或其他特殊字符。
Maximum string length:
60Pattern:
^[a-zA-Z0-9]*$示例:
"12345678"
发起该充值的汇款方信息。 当充值没有可用的汇款方资料时,仍会返回该对象,其字段为空字符串。
Show child attributes
Show child attributes
充值的附言。
示例:
"test reference"

