Simulate Deposit Creation
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"amount": 1000,
"currency": "USD",
"sender_swift_code": "WELGBE22",
"receiver_account_number": "SG123456789012345678",
"sender_account_number": "GB41TCCL12345634178496",
"sender_country": "<unknown>",
"sender_name": "UQPAY SG"
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit"
payload = {
"amount": 1000,
"currency": "USD",
"sender_swift_code": "WELGBE22",
"receiver_account_number": "SG123456789012345678",
"sender_account_number": "GB41TCCL12345634178496",
"sender_country": "<unknown>",
"sender_name": "UQPAY SG"
}
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-idempotency-key': '<x-idempotency-key>',
'x-auth-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 1000,
currency: 'USD',
sender_swift_code: 'WELGBE22',
receiver_account_number: 'SG123456789012345678',
sender_account_number: 'GB41TCCL12345634178496',
sender_country: '<unknown>',
sender_name: 'UQPAY SG'
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit', 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/simulation/deposit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 1000,
'currency' => 'USD',
'sender_swift_code' => 'WELGBE22',
'receiver_account_number' => 'SG123456789012345678',
'sender_account_number' => 'GB41TCCL12345634178496',
'sender_country' => '<unknown>',
'sender_name' => 'UQPAY SG'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-auth-token: <api-key>",
"x-idempotency-key: <x-idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit"
payload := strings.NewReader("{\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"sender_swift_code\": \"WELGBE22\",\n \"receiver_account_number\": \"SG123456789012345678\",\n \"sender_account_number\": \"GB41TCCL12345634178496\",\n \"sender_country\": \"<unknown>\",\n \"sender_name\": \"UQPAY SG\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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/simulation/deposit")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"sender_swift_code\": \"WELGBE22\",\n \"receiver_account_number\": \"SG123456789012345678\",\n \"sender_account_number\": \"GB41TCCL12345634178496\",\n \"sender_country\": \"<unknown>\",\n \"sender_name\": \"UQPAY SG\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"sender_swift_code\": \"WELGBE22\",\n \"receiver_account_number\": \"SG123456789012345678\",\n \"sender_account_number\": \"GB41TCCL12345634178496\",\n \"sender_country\": \"<unknown>\",\n \"sender_name\": \"UQPAY SG\"\n}"
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_status": "PENDING",
"complete_time": "2024-03-21T17:17:32+08:00",
"receiver_account_number": "12345678",
"sender": {
"sender_name": "UQPAY SG",
"sender_country": "<unknown>",
"sender_account_number": "12345678",
"sender_swift_code": "WELGBE22"
},
"create_time": "2024-03-21T17:17:32+08:00"
}Simulator
Simulate Deposit Creation
你可以使用此端点模拟向全球收款账户的充值。此功能仅在 sandbox 环境中可用。
POST
/
v1
/
simulation
/
deposit
Simulate Deposit Creation
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"amount": 1000,
"currency": "USD",
"sender_swift_code": "WELGBE22",
"receiver_account_number": "SG123456789012345678",
"sender_account_number": "GB41TCCL12345634178496",
"sender_country": "<unknown>",
"sender_name": "UQPAY SG"
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit"
payload = {
"amount": 1000,
"currency": "USD",
"sender_swift_code": "WELGBE22",
"receiver_account_number": "SG123456789012345678",
"sender_account_number": "GB41TCCL12345634178496",
"sender_country": "<unknown>",
"sender_name": "UQPAY SG"
}
headers = {
"x-idempotency-key": "<x-idempotency-key>",
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-idempotency-key': '<x-idempotency-key>',
'x-auth-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 1000,
currency: 'USD',
sender_swift_code: 'WELGBE22',
receiver_account_number: 'SG123456789012345678',
sender_account_number: 'GB41TCCL12345634178496',
sender_country: '<unknown>',
sender_name: 'UQPAY SG'
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit', 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/simulation/deposit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 1000,
'currency' => 'USD',
'sender_swift_code' => 'WELGBE22',
'receiver_account_number' => 'SG123456789012345678',
'sender_account_number' => 'GB41TCCL12345634178496',
'sender_country' => '<unknown>',
'sender_name' => 'UQPAY SG'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-auth-token: <api-key>",
"x-idempotency-key: <x-idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit"
payload := strings.NewReader("{\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"sender_swift_code\": \"WELGBE22\",\n \"receiver_account_number\": \"SG123456789012345678\",\n \"sender_account_number\": \"GB41TCCL12345634178496\",\n \"sender_country\": \"<unknown>\",\n \"sender_name\": \"UQPAY SG\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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/simulation/deposit")
.header("x-idempotency-key", "<x-idempotency-key>")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"sender_swift_code\": \"WELGBE22\",\n \"receiver_account_number\": \"SG123456789012345678\",\n \"sender_account_number\": \"GB41TCCL12345634178496\",\n \"sender_country\": \"<unknown>\",\n \"sender_name\": \"UQPAY SG\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"sender_swift_code\": \"WELGBE22\",\n \"receiver_account_number\": \"SG123456789012345678\",\n \"sender_account_number\": \"GB41TCCL12345634178496\",\n \"sender_country\": \"<unknown>\",\n \"sender_name\": \"UQPAY SG\"\n}"
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_status": "PENDING",
"complete_time": "2024-03-21T17:17:32+08:00",
"receiver_account_number": "12345678",
"sender": {
"sender_name": "UQPAY SG",
"sender_country": "<unknown>",
"sender_account_number": "12345678",
"sender_swift_code": "WELGBE22"
},
"create_time": "2024-03-21T17:17:32+08:00"
}授权
由 UQPay 提供的登录 API Token。
请求头
用于保持操作幂等性的唯一标识符(UUID),确保同一操作的重复执行不会产生意外影响或重复。它有助于在网络错误、重试或失败时保持数据一致性。
请求体
application/json
待充值的金额。
示例:
1000
受益人银行账户的 SWIFT 代码。
Maximum string length:
30示例:
"WELGBE22"
收款方的账号。
示例:
"SG123456789012345678"
汇款方的账号。
示例:
"GB41TCCL12345634178496"
面向客户展示的商户名称。
示例:
"UQPAY SG"
响应
200 - application/json
充值模拟成功。
充值 ID。
示例:
"72970a7c-7921-431c-b95f-3438724ba16f"
系统生成的用于标识该实体的编号。
示例:
"P220406-LLCVLRM"
充值的金额。
示例:
"10000"
充值的状态。
可用选项:
PENDING, COMPLETED, FAILED 示例:
"PENDING"
对象创建的完成时间。
示例:
"2024-03-21T17:17:32+08:00"
账号,多用于非欧洲国家/地区,account_number 与 iban 须填写其一。
仅允许英文字母(大小写)和数字;不允许使用短横线或其他特殊字符。
Maximum string length:
60Pattern:
^[a-zA-Z0-9]*$示例:
"12345678"
发起该充值的汇款方信息。
Show child attributes
Show child attributes
对象创建的创建时间。
示例:
"2024-03-21T17:17:32+08:00"
⌘I

