Skip to main content
POST
Simulate Deposit Creation

Authorizations

x-auth-token
string
header
required

由 UQPAY 提供的登录 API Token。

Headers

x-on-behalf-of
string

指定代表哪个子账户发起请求。应设为 account_id,可通过查询关联账户列表获取。如果省略或留空,请求将使用主账户执行。 更多信息参见关联账户。

x-idempotency-key
string<uuid>
required

用于保持操作幂等性的唯一标识符(UUID),确保同一操作的重复执行不会产生意外影响或重复。它有助于在网络错误、重试或失败时保持数据一致性。

Body

application/json
account_id
string
required

接收模拟充值的账户 ID。账户必须已激活且验证通过。

Example:

"eaf28076-017b-436f-a04c-212563a1aa4f"

amount
number
required

待充值的金额。

Example:

1000

currency
string
required

受益人银行账户中持有资金的币种。三位字母 ISO 4217 币种代码。

Required string length: 3
Example:

"USD"

sender_swift_code
string
required

受益人银行账户的 SWIFT 代码。

Maximum string length: 30
Example:

"WELGBE22"

receiver_account_number
string

收款方的账号。

Example:

"SG123456789012345678"

sender_account_number
string

汇款方的账号。

Example:

"GB41TCCL12345634178496"

sender_country
string

两位字母国家/地区代码 ISO 3166-1 alpha-2。

Required string length: 2
Example:

"SG"

sender_name
string

面向客户展示的商户名称。

Example:

"UQPAY SG"

Response

200 - application/json

充值模拟成功。

deposit_id
string
required

充值 ID。

Example:

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

short_reference_id
string
required

系统生成的用于标识该实体的编号。

Example:

"P220406-LLCVLRM"

amount
string
required

充值的金额。

Example:

"10000"

currency
string
required

受益人银行账户中持有资金的币种。三位字母 ISO 4217 币种代码。

Required string length: 3
Example:

"USD"

deposit_status
enum<string>
required

充值的状态。

Available options:
PENDING,
COMPLETED,
FAILED
Example:

"PENDING"

complete_time
string
required

对象创建的完成时间。

Example:

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

receiver_account_number
string
required

账号,多用于非欧洲国家/地区,account_number 与 iban 须填写其一。

仅允许英文字母(大小写)和数字;不允许使用短横线或其他特殊字符。

Maximum string length: 60
Pattern: ^[a-zA-Z0-9]*$
Example:

"12345678"

sender
object
required

发起该充值的汇款方信息。

create_time
string

对象创建的创建时间。

Example:

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