curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/virtual/accounts \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"country": "BH",
"currency": "GBP",
"payment_method": "SWIFT",
"nickname": "GBP collection account"
}
'{
"data": {
"account_id": "b1b89684-c2c4-4d54-b8a8-3572727fd120",
"application_id": "550e8400-e29b-41d4-a716-446655440001",
"country": "BH",
"currency": "EUR",
"direct_id": "0",
"public_version": 1,
"status": "SUBMITTED",
"results": [
{
"payment_method": "SWIFT",
"status": "SUBMITTED",
"virtual_accounts": [],
"error": null
}
]
}
}Virtual Accounts
Create Virtual Account
针对一个国家和一个币种申请虚拟账户银行信息。可以选择 LOCAL 或 SWIFT,也可以省略 payment_method,分别评估两种收款方式。
HTTP 200 表示申请已受理并进入异步处理。请保存 application_id 和 public_version,逐项处理结果,并且只使用状态为 ACTIVE 的银行信息。
同步错误表示没有创建申请,后续也不会产生申请 Webhook。
支持的参数组合、状态处理、错误及可用性规则详见通过 API 集成虚拟账户。
POST
/
v1
/
virtual
/
accounts
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/virtual/accounts \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"country": "BH",
"currency": "GBP",
"payment_method": "SWIFT",
"nickname": "GBP collection account"
}
'{
"data": {
"account_id": "b1b89684-c2c4-4d54-b8a8-3572727fd120",
"application_id": "550e8400-e29b-41d4-a716-446655440001",
"country": "BH",
"currency": "EUR",
"direct_id": "0",
"public_version": 1,
"status": "SUBMITTED",
"results": [
{
"payment_method": "SWIFT",
"status": "SUBMITTED",
"virtual_accounts": [],
"error": null
}
]
}
}授权
由 UQPAY 提供的登录 API Token。
请求头
本次申请的唯一键。仅在为同一账户重试相同请求时复用该键。输入规范化后,使用同一键提交不同的请求数据会返回错误。
Maximum string length:
64请求体
application/json
虚拟账户开户国家的两位国家代码。请使用接入指南列出的组合。系统会去除首尾空格,并接受小写输入。
可用选项:
SG, DK, GB, DE, AU, LU, BH 虚拟账户需要接收的三位币种代码。每次只能传一个值。系统会去除首尾空格,并接受小写输入。
可用选项:
SGD, USD, AUD, CNH, EUR, GBP, HKD, JPY, NOK, AED, NZD, CHF, CAD, KWD, MXN 要评估的收款方式。传 LOCAL 或 SWIFT 时只评估一种;省略,或传 null、空字符串、仅空白字符时,分别评估两种方式。不要传 ALL 或 AUTO。
可用选项:
LOCAL, SWIFT, 用于标记请求的可选名称。省略、为 null、为空或仅包含空白字符时按相同方式处理。申请接口和 Webhook 均不返回该值。
Maximum string length:
255示例:
"Operating account"
响应
OK —— 虚拟账户申请已受理并进入异步处理。
Show child attributes
Show child attributes

