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 '
{
"account_id": "eaf28076-017b-436f-a04c-212563a1aa4f",
"amount": 1,
"currency": "NOK",
"receiver_account_number": "11020075767",
"sender_name": "UQPAY Contract Test",
"sender_country": "SG",
"sender_account_number": "1234567890",
"sender_swift_code": "DBSSSGSG"
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit"
payload = {
"account_id": "eaf28076-017b-436f-a04c-212563a1aa4f",
"amount": 1,
"currency": "NOK",
"receiver_account_number": "11020075767",
"sender_name": "UQPAY Contract Test",
"sender_country": "SG",
"sender_account_number": "1234567890",
"sender_swift_code": "DBSSSGSG"
}
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({
account_id: 'eaf28076-017b-436f-a04c-212563a1aa4f',
amount: 1,
currency: 'NOK',
receiver_account_number: '11020075767',
sender_name: 'UQPAY Contract Test',
sender_country: 'SG',
sender_account_number: '1234567890',
sender_swift_code: 'DBSSSGSG'
})
};
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([
'account_id' => 'eaf28076-017b-436f-a04c-212563a1aa4f',
'amount' => 1,
'currency' => 'NOK',
'receiver_account_number' => '11020075767',
'sender_name' => 'UQPAY Contract Test',
'sender_country' => 'SG',
'sender_account_number' => '1234567890',
'sender_swift_code' => 'DBSSSGSG'
]),
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 \"account_id\": \"eaf28076-017b-436f-a04c-212563a1aa4f\",\n \"amount\": 1,\n \"currency\": \"NOK\",\n \"receiver_account_number\": \"11020075767\",\n \"sender_name\": \"UQPAY Contract Test\",\n \"sender_country\": \"SG\",\n \"sender_account_number\": \"1234567890\",\n \"sender_swift_code\": \"DBSSSGSG\"\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 \"account_id\": \"eaf28076-017b-436f-a04c-212563a1aa4f\",\n \"amount\": 1,\n \"currency\": \"NOK\",\n \"receiver_account_number\": \"11020075767\",\n \"sender_name\": \"UQPAY Contract Test\",\n \"sender_country\": \"SG\",\n \"sender_account_number\": \"1234567890\",\n \"sender_swift_code\": \"DBSSSGSG\"\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 \"account_id\": \"eaf28076-017b-436f-a04c-212563a1aa4f\",\n \"amount\": 1,\n \"currency\": \"NOK\",\n \"receiver_account_number\": \"11020075767\",\n \"sender_name\": \"UQPAY Contract Test\",\n \"sender_country\": \"SG\",\n \"sender_account_number\": \"1234567890\",\n \"sender_swift_code\": \"DBSSSGSG\"\n}"
response = http.request(request)
puts response.read_body{
"sender_bank": {
"bank_name": "",
"bank_address": ""
},
"deposit_id": "984164be-e5c9-4603-b39a-d3981eae146d",
"short_reference_id": "260909-R3OVNXNO",
"amount": "1",
"currency": "NOK",
"deposit_fee": "0",
"create_time": "2026-09-09T18:02:00.842176436+08:00",
"complete_time": "0001-01-01T00:00:00Z",
"deposit_status": "PENDING",
"receiver_account_number": "11020075767",
"deposit_reference": "",
"sender": {
"sender_name": "UQPAY Contract Test",
"sender_country": "SG",
"sender_account_number": "1234567890",
"sender_swift_code": "DBSSSGSG",
"sender_address": ""
}
}Simulate Deposit Creation
You can use this endpoint to simulate deposits into your global account. This is only available in the sandbox environment.
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 '
{
"account_id": "eaf28076-017b-436f-a04c-212563a1aa4f",
"amount": 1,
"currency": "NOK",
"receiver_account_number": "11020075767",
"sender_name": "UQPAY Contract Test",
"sender_country": "SG",
"sender_account_number": "1234567890",
"sender_swift_code": "DBSSSGSG"
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/simulation/deposit"
payload = {
"account_id": "eaf28076-017b-436f-a04c-212563a1aa4f",
"amount": 1,
"currency": "NOK",
"receiver_account_number": "11020075767",
"sender_name": "UQPAY Contract Test",
"sender_country": "SG",
"sender_account_number": "1234567890",
"sender_swift_code": "DBSSSGSG"
}
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({
account_id: 'eaf28076-017b-436f-a04c-212563a1aa4f',
amount: 1,
currency: 'NOK',
receiver_account_number: '11020075767',
sender_name: 'UQPAY Contract Test',
sender_country: 'SG',
sender_account_number: '1234567890',
sender_swift_code: 'DBSSSGSG'
})
};
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([
'account_id' => 'eaf28076-017b-436f-a04c-212563a1aa4f',
'amount' => 1,
'currency' => 'NOK',
'receiver_account_number' => '11020075767',
'sender_name' => 'UQPAY Contract Test',
'sender_country' => 'SG',
'sender_account_number' => '1234567890',
'sender_swift_code' => 'DBSSSGSG'
]),
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 \"account_id\": \"eaf28076-017b-436f-a04c-212563a1aa4f\",\n \"amount\": 1,\n \"currency\": \"NOK\",\n \"receiver_account_number\": \"11020075767\",\n \"sender_name\": \"UQPAY Contract Test\",\n \"sender_country\": \"SG\",\n \"sender_account_number\": \"1234567890\",\n \"sender_swift_code\": \"DBSSSGSG\"\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 \"account_id\": \"eaf28076-017b-436f-a04c-212563a1aa4f\",\n \"amount\": 1,\n \"currency\": \"NOK\",\n \"receiver_account_number\": \"11020075767\",\n \"sender_name\": \"UQPAY Contract Test\",\n \"sender_country\": \"SG\",\n \"sender_account_number\": \"1234567890\",\n \"sender_swift_code\": \"DBSSSGSG\"\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 \"account_id\": \"eaf28076-017b-436f-a04c-212563a1aa4f\",\n \"amount\": 1,\n \"currency\": \"NOK\",\n \"receiver_account_number\": \"11020075767\",\n \"sender_name\": \"UQPAY Contract Test\",\n \"sender_country\": \"SG\",\n \"sender_account_number\": \"1234567890\",\n \"sender_swift_code\": \"DBSSSGSG\"\n}"
response = http.request(request)
puts response.read_body{
"sender_bank": {
"bank_name": "",
"bank_address": ""
},
"deposit_id": "984164be-e5c9-4603-b39a-d3981eae146d",
"short_reference_id": "260909-R3OVNXNO",
"amount": "1",
"currency": "NOK",
"deposit_fee": "0",
"create_time": "2026-09-09T18:02:00.842176436+08:00",
"complete_time": "0001-01-01T00:00:00Z",
"deposit_status": "PENDING",
"receiver_account_number": "11020075767",
"deposit_reference": "",
"sender": {
"sender_name": "UQPAY Contract Test",
"sender_country": "SG",
"sender_account_number": "1234567890",
"sender_swift_code": "DBSSSGSG",
"sender_address": ""
}
}Authorizations
The API token for login provided by UQPAY.
Headers
Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account.
More information at Connected Accounts.
A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.
Body
application/json
The ID of the account receiving the simulated deposit. The account must be active and verified.
Example:
"eaf28076-017b-436f-a04c-212563a1aa4f"
The amount to deposit.
Example:
1000
Swift code of the beneficiary's bank account.
Maximum string length:
30Example:
"WELGBE22"
The receiver's account number.
Example:
"SG123456789012345678"
The sender's account number.
Example:
"GB41TCCL12345634178496"
The customer-facing business name.
Example:
"UQPAY SG"
Response
200 - application/json
Deposit simulated successfully.
The deposit id.
Example:
"72970a7c-7921-431c-b95f-3438724ba16f"
The reference generated by the system to identify the entity.
Example:
"P220406-LLCVLRM"
The amount of the deposit.
Example:
"10000"
The status of the deposit.
Available options:
PENDING, COMPLETED, FAILED Example:
"PENDING"
Completed time at which the object was created.
Example:
"2024-03-21T17:17:32+08:00"
Account number, mostly for non-european countries, either account_number or iban should be filled.
Only English letters (uppercase and lowercase) and digits are allowed; dashes or other special characters are not permitted.
Maximum string length:
60Pattern:
^[a-zA-Z0-9]*$Example:
"12345678"
Details of the sender who initiated the deposit.
Show child attributes
Show child attributes
Create time at which the object was created.
Example:
"2024-03-21T17:17:32+08:00"