汇款接口
功能概述
本接口用于商户自行进行批量汇款，可将多笔购汇合并汇款。
接口地址
https://apis.5upay.com/foreignExchange/transfer
| 参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
| merchantId |
商户编号 |
varchar(9) |
商户在首信易系统的唯一id，可在商户后台查看 |
M |
| requestId |
汇款订单号 |
varchar(50) |
汇款订单号为商户自行拟定，提交的订单号必须在自身平台交易中唯一。首信易支付系统已汇款成功或失败的订单，商户平台不能以相同的订单号再次提交。 |
M |
| originalRequestIds |
原购汇订单号 |
数组 |
原商户购汇订单号 |
M |
| payee |
汇款信息 |
JSON |
见下表,支付信息 |
M |
| notifyUrl |
通知地址 |
varchar(200) |
服务器通知：汇款成功后会向该地址发送成功通 知，该地址可以带参数(发送机制见应答机制)， 如 : “www.5upay.com/callback.action?t est=test” |
M |
| hmac |
参数签名 |
varchar(500) |
商户生成的参数签名结果，获取hmac的方法请参考请求加密流程 |
M |
请求参数列表 （payee，支付信息）
| 参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
| recName |
收款方姓名 |
varchar(200) |
收款方姓名 |
M |
| accountNumber |
收款方账号 |
varchar(100) |
收款方账号 |
M |
| recAddress |
收款方地址 |
varchar(200) |
收款方地址 |
O |
| countryCode |
收款方常驻国家代码 |
varchar(3) |
见国家列表 |
M |
| ibanCode |
IBAN |
varchar(40) |
IBAN |
O |
| bankName |
收款行名称 |
varchar(200) |
收款行名称 |
M |
| swiftCode |
收款行 SWIFT |
varchar(20) |
收款行 SWIFT |
O |
| routingCode |
Routing Number |
varchar(20) |
Routing Number |
O |
| bsbCode |
BSB Number |
varchar(20) |
BSB Number |
O |
| bankAddress |
收款行地址 |
varchar(200) |
收款行地址 |
O |
| postScript |
汇款附言 |
varchar(140) |
汇款附言 |
O |
| proxyBankAccou ntNumber |
收款行在其代理行账号 |
varchar(100) |
收款行在其代理行账号 |
O |
| proxyBankName |
收款行之代理行名称 |
varchar(200) |
收款行之代理行名称 |
O |
| proxySwiftCode |
收款行之代理行SWIFT |
varchar(20) |
收款行之代理行SWIFT |
O |
| proxyBank Address |
收款行之代理行地址 |
varchar(200) |
收款行之代理行地址 |
O |
参数示例
<![CDATA[
{
"merchantId": "100000050",
"requestId": "1528687520838",
"originalRequestIds": ["1524555046860", "1524555046861"],
"payee": {
"recName": "name",
"accountNumber": "1234567890",
"recAddress": "123",
"countryCode": "156",
"ibanCode": "",
"bankName": "中国工商银行",
"swiftCode": "12345678",
"routingCode": "",
"bsbCode": "",
"bankAddress": "",
"postScript": "",
"proxyBankAccountNumber": "",
"proxyBankName": "",
"proxySwiftCode": "",
"proxyBankAddress": ""
},
"notifyUrl": "notify",
"hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi9s16uvSRmj07M3ax76
JG6STpWc/kyb36mWmg8X8gduvd39NupWK/zJErbgYffOmOd6YpmrvTQhbPioxLN8Ras9J9zkL
7uQ3cTOaLAHOeAQh7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrBY7OQ7cLT
czfe5DOxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9NsRsGc0pNXZq+gz0hvTq1dL
w+WygTVH8VPFN01bPVHQjxJd3M041kE9ABF/vAP1ExXtSNCevRrAjyyRi4Q=="
}
]]>
请求同步返回参数列表
| 参数名称 |
参数中文名称 |
参数说明 |
| merchantId |
商户编号 |
同请求参数 |
| requestId |
汇款订单号 |
同请求参数 |
| status |
汇款订单号 |
SUCCESS 提交成功 |
| ERROR 提交失败 |
| hmac |
参数签名 |
商户生成的参数签名结果，获取hmac的方法请参考请求加密流程 |
示例
<![CDATA[
{
"merchantId": "100000050",
"requestId": "1528687520838",
"status": "SUCCESS",
"hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi9s16uvSRmj07M3ax76
JG6STpWc/kyb36mWmg8X8gduvd39NupWK/zJErbgYffOmOd6YpmrvTQhbPioxLN8Ras9J9zkL
7uQ3cTOaLAHOeAQh7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrBY7OQ7cLT
czfe5DOxJHLGSMpinHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9NsRsGc0pNXZq+gz0hvTq1dL
w+WygTVH8VPFN01bPVHQjxJd3M041kE9ABF/vAP1ExXtSNCevRrAjyyRi4Q=="
}
]]>
订单异步返回参数列表
| 参数名称 |
参数中文名称 |
参数说明 |
| merchantId |
商户编号 |
同请求参数 |
| requestId |
汇款订单号 |
同请求参数 |
| serialNumber |
支付流水号 |
首信易系统交易流水号 |
| status |
汇款状态 |
SUCCESS 成功 |
| FAILED 失败 |
| amount |
汇款金额 |
单位:分，1 元=100分 |
| currency |
汇款币种 |
参考货币列表 |
| completeDataTime |
创建时间 |
汇款完成时间 |
| hmac |
参数签名 |
商户生成的参数签名结果，获取hmac的方法请参考请求加密流程 |
示例
<![CDATA[
{
"merchantId": "100000050",
"requestId": "1506333222530",
"serialNumber": "8a7df26c5e74e383015eb87509ab3b4a",
"amount": "10",
"currency": "CNY",
"completeDateTime": "2018-05-25 18:00:03",
"status": "SUCCESS",
"hmac": "UZYjA/bik4TNL9aYSHajULOJxDSJkFyYfDNFxJxYCG1Zyi9s16uvSRmj07M3ax76JG6ST
pWc/kyb36mWmg8X8gduvd39NupWK/zJErbgYffOmOd6YpmrvTQhbPioxLN8Ras9J9zkL7uQ3cTOaLA
HOeAQh7Aps3EFJ8MMh+sY4UwIl25h3PEkbBy2sBoug+ZpgLYDXTULrBY7OQ7cLTczfe5DOxJHLGSMp
inHaVFOvQaodR8yZdAygDyfDPm16mKDBBV9NsRsGc0pNXZq+gz0hvTq1dLw+WygTVH8VPFN01bPVHQ
jxJd3M041kE9ABF/vAP1ExXtSNCevRrAjyyRi4Q=="
}
]]>