跳转到主要内容
GET
List Beneficiaries

授权

x-auth-token
string
header
必填

由 UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

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

查询参数

page_size
integer
必填

每页返回的最大条目数。必须在 10 到 100 之间(含)。

必填范围: 1 <= x <= 100
示例:

10

page_number
integer
必填

用于获取特定一组条目的页码。必须 大于等于 1

必填范围: x >= 1
示例:

1

entity_type
enum<string>

指定用于筛选的受益人实体类型。有效值为:

  • COMPANY:企业实体
  • INDIVIDUAL:个人账户
可用选项:
COMPANY,
INDIVIDUAL
nickname
string

受益人昵称 受益人昵称。

Maximum string length: 120
示例:

"John Doe"

currency
string

指定获取交易所用的币种。币种代码遵循 ISO 4217 标准。

示例:

"USD"

company_name
string

受益人所属公司 受益人的公司名称,仅当 entity_type 为 COMPANY 时存在。

  • payment_method = SWIFT 时:

    • 仅可包含英文字母、数字、特殊字符(半角格式)和空格。
    • 允许的特殊字符:-_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……
  • payment_method = LOCAL 时:

    • 不应用严格的校验规则,支持本地语言字符。
  • bank_details.bank_country_code = SGbank_details.account_currency_code = SGD 时无需传入此字段

  • bank_country_code = CNaccount_currency_code = CNHpayment_method = LOCALentity_type = COMPANY 时,支持中文字符和中文括号 ()

Maximum string length: 120
Pattern: ^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$
示例:

"UQPAY TECHNOLOGY SG PTE LTD"

响应

200 - application/json

OK —— 成功获取受益人列表。

total_pages
integer

可用条目的总页数。

示例:

10

total_items
integer

可用条目的总数。

示例:

105

data
object[]