curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"entity_type": "COMPANY",
"company_name": "UQPAY PTE. LTD.",
"payment_method": "SWIFT",
"nickname": "Contract 452d7f6f",
"email": "contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com",
"bank_details": {
"bank_name": "GREEN LINK DIGITAL BANK",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"account_holder": "UQPAY PTE. LTD.",
"account_currency_code": "SGD",
"account_number": "11020075767",
"clearing_system": "SWIFT",
"swift_code": "GLDTSGSGXXX"
},
"address": {
"country": "SG",
"city": "Singapore",
"state": "Singapore",
"street_address": "Sandbox Contract Test",
"postal_code": 18989
}
}
'{
"beneficiary_id": "285d9110-ed8e-4bb3-b206-f0a7d6d4aaeb",
"short_reference_id": "BF260911-OGJMC98L"
}Beneficiaries
Create Beneficiary
保存收款人的收款信息，供后续出款使用。
提供所选支付方式要求的收款人信息。保存返回的受益人 ID，用于 Create Payout。
POST
/
v1
/
beneficiaries
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--header 'x-idempotency-key: <x-idempotency-key>' \
--data '
{
"entity_type": "COMPANY",
"company_name": "UQPAY PTE. LTD.",
"payment_method": "SWIFT",
"nickname": "Contract 452d7f6f",
"email": "contract-452d7f6f-4ef2-4751-8af5-38760b977a22@example.com",
"bank_details": {
"bank_name": "GREEN LINK DIGITAL BANK",
"bank_address": "MAPLETREE BUSINESS CITY 20 PASIR PANJANG ROAD 07-25/28 SINGAPORE",
"bank_country_code": "SG",
"account_holder": "UQPAY PTE. LTD.",
"account_currency_code": "SGD",
"account_number": "11020075767",
"clearing_system": "SWIFT",
"swift_code": "GLDTSGSGXXX"
},
"address": {
"country": "SG",
"city": "Singapore",
"state": "Singapore",
"street_address": "Sandbox Contract Test",
"postal_code": 18989
}
}
'{
"beneficiary_id": "285d9110-ed8e-4bb3-b206-f0a7d6d4aaeb",
"short_reference_id": "BF260911-OGJMC98L"
}授权
由 UQPAY 提供的登录 API Token。
请求头
用于保持操作幂等性的唯一标识符（UUID），确保同一操作的重复执行不会产生意外影响或重复。它有助于在网络错误、重试或失败时保持数据一致性。
请求体
application/json
- Company bank beneficiary
- Individual bank beneficiary
- Company Mastercard beneficiary
- Individual Mastercard beneficiary
受益人实体的类型。
示例:
"COMPANY"
受益人的公司名称，仅当 entity_type 为 COMPANY 时存在。
-
当
payment_method = SWIFT时：- 仅可包含英文字母、数字、特殊字符（半角格式）和空格。
- 允许的特殊字符：
-_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……
-
当
payment_method = LOCAL时：- 不应用严格的校验规则，支持本地语言字符。
-
当
bank_details.bank_country_code = SG且bank_details.account_currency_code = SGD时无需传入此字段 -
当
bank_country_code = CN且account_currency_code = CNH且payment_method = LOCAL且entity_type = COMPANY时，支持中文字符和中文括号（）。
Maximum string length:
120Pattern:
^[a-zA-Z0-9 -_().,@#~!$%^&*+={}\|:"'<>?/・……]*$示例:
"UQPAY TECHNOLOGY SG PTE LTD"
银行受益人的支付方式。
可用选项:
LOCAL, SWIFT 示例:
"LOCAL"
Show child attributes
Show child attributes
受益人的地址。
- 当
bank_details.bank_country_code = SG且bank_details.account_currency_code = SGD时无需传入此字段
Show child attributes
Show child attributes
受益人的电子邮箱地址。
示例:
"example@uqpay.com"
受益人昵称。
Maximum string length:
120示例:
"John Doe"
受益人的附加信息。
Show child attributes
Show child attributes