下单提交接口

功能概述

本接口作用是能够不通过商户后台直接通过 api 发起跨境汇款,商户可将此接口集成到商户自身运营后台上,以便运营人员直接发起。

接口地址

https://apis.5upay.com/transfer/order

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(20) 商户编号 M
requestId 订单号 varchar(50) 提交的订单号必须在自身账户交易中唯一;首信易支付系统中对于已付或者撤销的订单,商户端不能那个重复提交。 M
amount 汇款金额 decimal(18) 单位:分,1 元=100 分 M
currency 汇单金额币种 varchar(15) CNY(人民币)、USD(美元)、JPY(日元)、EUR(欧元)、CHF(瑞士法郎)GBP(英镑)、CAD(加拿大元)、AUD(澳大利亚元)、HKD(港币) M
creditedCurrency 预计到账币种 varchar(15) CNY(人民币)、USD(美元)、JPY(日元)、EUR(欧元)、CHF(瑞士法郎)、GBP(英镑)、CAD(加拿大元)、AUD(澳大利亚元)、HKD(港币) M
transferMode 汇款类型 varchar DETAIL:明细汇款 M
transferBusinessType 业务类型 固定值 STUDYABROAD 留学 M
GOODSTRADE 货物贸
PLANETICKET 机票
HOTELACCOMMODATION 酒店住宿
SOFTWARE 软件
TRAVEL 旅游
LOGISTICS 物流
OTHER 其它
singleReceiveAccount 是否单账户 varchar true:是 false:否 M
isMerger 是否合并 varchar true:是 false:否 M
detailPath 上传明细地址 varchar(200) 文件模板请见交易明细模板.xlsx, 明细文件需要上传到 ftp M
listpriceToken 锁定牌价标识 varchar(32) 见锁定牌价接口的锁定牌价标识,如不传则获取实时牌价 O
notifyUrl 通知地址 varchar(200) 支付成功后首信易支付会向该地址发送五次成功通知,该地址可以带参数,“www.5upay.com/callback.action?test=test”注意:如不填 notifyUr的参数值订单成功后您的服务器将得不到成功的通知。 M
payee 汇款信息 JSON 见下表,汇款信息 C
validateId 校验号 varchar(200) 调用数据校验接口返回的参数,在发起大批量(500 条以上)的明细汇款时需使用此参数 O
hmac 参数签名 varchar(500) 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 M

请求参数列表 (payee,汇款信息)

注:如果是单账户,需要填写收款账户

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
recName 收款方姓名 varchar(50) 收款方姓名 M
accountNumber 收款方账号 varchar(50) 收款方姓名 M
recAddress 收款方地址 varchar(200) 收款方地址 C
countryCode 收款方常驻国家代码 varchar(3) 见国家列表 M
ibanCode IBAN varchar IBAN O
bankName 收款行名称 varchar 收款行名称 M
swiftCode 收款行 SWIFT varchar 收款行 SWIFT 和收款行地址不能同时为空 C
routingCode Routing Number varchar Routing Numbe O
bsbCode BSB Number varchar BSB Number O
bankAddress 收款行地址 varchar 收款行 SWIFT 和收款行地址不能同时为空 C
postScript 汇款附言 varchar(140) 汇款附言 O
proxyBankAccountNumber 收款行在其代理行账号 varchar 收款行在其代理行账号 O
proxyBankName 收款行之代理行名称 varchar 收款行之代理行名称 O
proxySwiftCode 收款行之代理行SWIFT varchar 收款行之代理行 SWIFT O
proxyBankAddress 收款行之代理行地址 varchar 收款行之代理行地址 O

参数示例

{ "amount": "100", "isMerger": "false", "contractPath": "", "creditedCurrency": "USD", "currency": "CNY", "detailPath": "test00001_20180311.xls", "listPriceToken": "", "merchantId": "120141994", "notifyUrl": "notify", "payee": { "recName": "name", "accountNumber": "1234567890", "recAddress": "123", "countryCode": "156" "bankName": "中国工商银行", "swiftCode": "12345678" }, "requestId": "1528438523950", "singleReceiveAccount": "true", "transferMode": "DETAIL", "hmac": null }

请求同步返回参数列表

参数名称 参数中文名称 参数说明
merchantId 商户编号 商户在首信易系统的唯一身份标识,商户完成首信易系统注册后可登录商户后台商户服务查看。
requestId 订单号 订单号为商户自行拟定,提交的订单号必须在自身平台交易中唯一。首信易支付系统已付或撤销的订单,商户平台不能以相同的订单号再次提交。
status 请求状态 成功 SUCCESS,请求已接收
失败 FAILE
错误 ERRO
hmac 参数签名 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程

示例

{ "merchantId": "120141994", "requestId": "1527746602492", "hmac": "959e138ad2e290328e8d59fd124c618f", "status": "SUCCESS" }

订单异步返回参数列表

参数名称 参数中文名称 参数说明
merchantId 商户编号 商户编号
requestId 订单号 提交的订单号必须在自身账户交易中唯一;首信易支付系统中对于已付或者撤销的订单,商户端不能那个重复提交。
serialNumber 交易流水号 首信易系统交易流水号
currency 汇单金额币种 CNY(人民币)、USD(美元)、JPY(日元)、EUR(欧元)、CHF(瑞士法郎)GBP(英镑)、CAD(加拿大元)、AUD(澳大利亚元)、HKD(港币)
amount 支付金额 单位:分,1 元=100
status 汇款状态 SUCCESS 提交成功
CANCEL 提交失败
completeDataTime 创建时间 汇款完成时间
foexignExchangeResponse 购汇返回参数 见下表,购汇返回参数
hmac 参数签名 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程

返回参数(foexignExchangeResponse,购汇返回参数)

参数名称 参数中文名称 类型& 长度 参数说明
amount 购汇金额 decimal(18) 单位:分,1 元=100 分
currency 购汇币种 varchar(15) CNY(人民币)、USD(美元)、JPY(日元)、EUR(欧元)、CHF(瑞士法郎)GBP(英镑)、CAD(加拿大元)、AUD(澳大利亚元)、HKD(港币)
status 购汇状态 varchar(10) SUCCESS 提交成功
CANCEL 提交失败
listprice 牌价标识 varchar(32) 牌价标识
deductionAmount 购汇扣减额 decimal(18) 购汇扣除的人民币金额
completeDataTime 购汇时间 varchar(20) 购汇完成时间

示例

{ "merchantId": "120141994", "requestId": "1493799454674", "serialNumber": "2ae9fe97b3fb4f5ab85effb7ba4461ca", "currency": "CNY", "amount": "70", "completeDateTime": "2018-05-04 14:11:23", "foexignExchangeResponse": { "amount": 10, "currency": "USD", "status": "INIT", "deductionAmount": 65, "completeDataTime": "2018-05-05 10:56:32" }, "status": "SUCCESS", "hmac": null }