- 欢迎接入珊瑚开放平台
- 接入指南
- 进件
- 存款
- 付款
- 发行
- 辅助工具
- 多币种钱包
- 换汇
- 事件订阅
- 附录
受益人申请
POST
/v1/beneficiary/apply
最后修改时间:2025-03-19 01:59:58
请求参数
Header 参数
X-Request-Id
string
请求标识
默认值:
{{X-Request-Id}}
Body 参数application/json
partnerSerialNumber
string
必需
<= 36 字符
scene
enum<string>
场景类型
枚举值:
WITHDRAWALTRANSFER
accountNumber
string
银行账号
accountHolder
string
必需
币种为非 CNY 下只允许为英文、数字以及英文符号「含空格」
bankName
string
必需
币种为非 CNY 下只允许为英文、数字以及英文符号「含空格」
bankAddress
string
必需
币种为非 CNY & 转账场景下只允许为英文、数字以及英 文符号「含空格」
bankBranch
string
开户支行名称
bankBic
string
可选
币种为非 CNY & 转账场景下必填
country
enum<string>
国家
枚举值:
ADAEAFAGAIALAMAOARATAUAWAZBABBBDBEBFBGBHBIBJBMBNBOBRBSBTBWBYBZCACDCFCGCHCICKCLCMCNCOCRCUCVCYCZDEDJDKDMDODZECEEEGERESETFIFJFKFMFOFRGAGBGDGEGFGHGIGLGMGNGPGQGRGTGUGWGYHKHNHRHTHUIDIEILINIQIRISITJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENGNINLNONPNRNZOMPAPEPFPGPHPKPLPMPRPSPTPWPYQARERORURWSASBSCSDSESGSHSKSLSMSNSOSRSTSVSYSZTCTDTGTHTJTMTNTOTRTTTVTWTZUAUGUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
currency
enum<string>
币种
枚举值:
USDEURJPYGBPAUDCADCNYIDRSGDHKDKRWDKKMYRTHBAEDVND
beneficiaryName
string
可选
转账场景下必填
币种为非 CNY & 转账场景下只允许为英文、数字以及英文符号「含空格」
beneficiaryCountry
enum<string>
可选
转账场景下必填
枚举值:
ADAEAFAGAIALAMAOARATAUAWAZBABBBDBEBFBGBHBIBJBMBNBOBRBSBTBWBYBZCACDCFCGCHCICKCLCMCNCOCRCUCVCYCZDEDJDKDMDODZECEEEGERESETFIFJFKFMFOFRGAGBGDGEGFGHGIGLGMGNGPGQGRGTGUGWGYHKHNHRHTHUIDIEILINIQIRISITJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENGNINLNONPNRNZOMPAPEPFPGPHPKPLPMPRPSPTPWPYQARERORURWSASBSCSDSESGSHSKSLSMSNSOSRSTSVSYSZTCTDTGTHTJTMTNTOTRTTTVTWTZUAUGUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
beneficiaryAddress
string
可选
转账场景下必填
币种为非 CNY & 转账场景下只允许为英文、数字以及英文符号「含空格」
account
enum<string>
账户类型
枚举值:
PERSONALCOMPANY
document
array[string]
可选
必填场景〔转账场景 & 币种为 CNY〕 | 〔提现场景〕
文件内容
1.
2.
文件格式支持 .pdf .xls .xlsx .doc .docx .jpg .jpeg .png 数量不超过 5 个
单个文件大小不超过 10 M
使用文件上传接口上传后, 置入文件标识
示例
{
"partnerSerialNumber": "string",
"scene": "WITHDRAWAL",
"accountNumber": "string",
"accountHolder": "string",
"bankName": "string",
"bankAddress": "string",
"bankBranch": "string",
"bankBic": "string",
"country": "AD",
"currency": "USD",
"beneficiaryName": "string",
"beneficiaryCountry": "AD",
"beneficiaryAddress": "string",
"account": "PERSONAL",
"document": [
"string"
]
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://gateway-openapi.coralglobal.cn/v1/beneficiary/apply' \
--header 'X-Request-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
"partnerSerialNumber": "string",
"scene": "WITHDRAWAL",
"accountNumber": "string",
"accountHolder": "string",
"bankName": "string",
"bankAddress": "string",
"bankBranch": "string",
"bankBic": "string",
"country": "AD",
"currency": "USD",
"beneficiaryName": "string",
"beneficiaryCountry": "AD",
"beneficiaryAddress": "string",
"account": "PERSONAL",
"document": [
"string"
]
}'
返回响应
🟢200成功
application/json
Body
code
string
错误编码
message
string
错误信息
data
object (BeneficiaryApplyVO)
响应主体
beneficiaryId
string
受益人标识
partnerSerialNumber
string
可选
timestamp
string
时间戳
示例
{
"code": "",
"message": "",
"data": {
"beneficiaryId": "",
"partnerSerialNumber": ""
},
"timestamp": ""
}
修改于 2025-03-19 01:59:58