Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Simulator

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

Headers

x-on-behalf-ofstring

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 API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring uuid

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.

Request body

amountnumber required

The amount to deposit.

currencystring required

Three-letter currency code

receiver_account_numberstring

The receiver's account number.

sender_swift_codestring required

Swift code of the beneficiary's bank account.

sender_account_numberstring

The sender's account number.

sender_countrystring

Two-letter country code ISO 3166-1 alpha-2.

sender_namestring

The customer-facing business name.

Example request

{
  "amount": 1000,
  "receiver_account_number": "SG123456789012345678",
  "sender_swift_code": "WELGBE22",
  "sender_account_number": "GB41TCCL12345634178496",
  "sender_country": "SG",
  "sender_name": "UQPAY SG"
}

Response

Deposit simulated successfully.

deposit_idstring required

The deposit id.

short_reference_idstring required

The reference generated by the system to identify the entity.

amountstring required

The amount of the deposit.

currencystring required

Three-letter currency code

deposit_status'PENDING' | 'COMPLETED' | 'FAILED' required

The status of the deposit.

create_timestring

Create time at which the object was created.

complete_timestring required

Completed time at which the object was created.

receiver_account_numberstring 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.

Example response

{
  "deposit_id": "72970a7c-7921-431c-b95f-3438724ba16f",
  "short_reference_id": "P220406-LLCVLRM",
  "amount": "10000",
  "deposit_status": "PENDING",
  "create_time": "2024-03-21T17:17:32+08:00",
  "complete_time": "2024-03-21T17:17:32+08:00",
  "receiver_account_number": "12345678",
  "sender": {
    "sender_name": "UQPAY SG",
    "sender_country": "SG",
    "sender_account_number": "12345678",
    "sender_swift_code": "WELGBE22"
  }
}