Skip to main content
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"
}
'
{
  "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"
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

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.

​
x-idempotency-key
string<uuid>
required

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
​
amount
number
required

The amount to deposit.

Example:

1000

​
currency
string
required

Currency in which money is held in the beneficiary's bank account. Three-letter ISO 4217 currency code.

Required string length: 3
Example:

"USD"

​
sender_swift_code
string
required

Swift code of the beneficiary’s bank account.

Maximum string length: 30
Example:

"WELGBE22"

​
receiver_account_number
string

The receiver's account number.

Example:

"SG123456789012345678"

​
sender_account_number
string

The sender's account number.

Example:

"GB41TCCL12345634178496"

​
sender_country
any
​
sender_name
string

The customer-facing business name.

Example:

"UQPAY SG"

Response

Deposit simulated successfully.

​
deposit_id
string
required

The deposit id.

Example:

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

​
short_reference_id
string
required

The reference generated by the system to identify the entity.

Example:

"P220406-LLCVLRM"

​
amount
string
required

The amount of the deposit.

Example:

"10000"

​
currency
string
required

Currency in which money is held in the beneficiary's bank account. Three-letter ISO 4217 currency code.

Required string length: 3
Example:

"USD"

​
deposit_status
enum<string>
required

The status of the deposit.

Available options:
PENDING,
COMPLETED,
FAILED
Example:

"PENDING"

​
complete_time
string
required

Completed time at which the object was created.

Example:

"2024-03-21T17:17:32+08:00"

​
receiver_account_number
string
required

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: 60
Pattern: ^[a-zA-Z0-9]*$
Example:

"12345678"

​
sender
object
required

Details of the sender who initiated the deposit.

​
create_time
string

Create time at which the object was created.

Example:

"2024-03-21T17:17:32+08:00"