发起收汇接口
功能概述
商户通过向首信易支付指定的 URL 发送收汇请求,并接收首信易支付返回的结果数据。
接口地址
https://apis.5upay.com/foreignpayExchangesettlement/batch/order
| 参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
| merchantId |
商户编号 |
varchar(20) |
商户在首信易系统的唯一身份标识,商户完成首信易系统注册后可登录商户后台商户服务查看。 |
M |
| requestId |
订单号 |
varchar(50) |
订单号为商户自行拟定,提交的订单号必须在自身平台交易中唯一。 |
M |
| amount |
订单金额 |
varchar(18) |
订单金额,单位:分 |
M |
| currency |
到账币种 |
varchar(3) |
CNY 人民币 |
M |
| forUse |
业务分类 |
固定值 |
GOODSTRADE 货物贸易 |
M |
| notifyUrl |
通知地址 |
varchar(50) |
通知地址 |
M |
| remark |
备注 |
varchar(300) |
备注 |
M |
| payer |
收款人信息 |
JSON |
收款人信息 |
M |
| paymentModeCode |
支付方式编码 |
固定值 |
FOREIGN-CNY-JSBANK-P2P |
M |
| timeout |
超时时间 |
varchar(300) |
超时时间,单位:小时 |
M |
| tradeMode |
交易模式 |
varchar(300) |
交易模式 |
M |
| B2C |
| B2B |
| validateId |
校验号 |
varchar(300) |
校验号,明细校验接口返回的validateId首信易系统校验号 |
C |
| hmac |
参数签名 |
varchar(500) |
商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 |
M |
请求参数(payer,付款人信息)
| 参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
| name |
付款人姓名 |
varchar(100) |
付款人姓名 |
M |
| bankName |
付款银行名称 |
varchar(32) |
付款银行名称 |
M |
| bankCardNum |
付款银行卡号\账户号 |
varchar(32) |
付款银行卡号\账户号 |
M |
| nationality |
付款人国籍 |
varchar(3) |
付款人国籍,3位数字国家代码,国际标准:ISO 3166-1 |
M |
参数示例
{
"merchantId": "896667346",
"requestId": "205d37ddc32740a9b39b8fd594f7eb4c",
"amount": 99993000,
"currency": "CNY",
"forUse": "GOODSTRADE",
"notifyUrl": "https://qa-bankchannel.ajbridge.com/foreignpay/payease/callback",
"paymentModeCode": "FOREIGN-CNY-JSBANK-P2P",
"timeout": 100,
"tradeMode": "B2C",
"validateId": "2c98a79c9a813d1d019a86be4d47001f",
"payer": {
"bankCardNum": "847***9847",
"bankName": "b",
"name": "a",
"nationality": "344"
},
"hmac": "sIV5QzWbwwbpXA4ZARRhaaEYf7iLoUTpz7PelHj3m5fO3WnmgDjQ+VoOgpEZMC5wQ=="
}
同步返回参数列表
| 参数名称 |
参数中文名称 |
参数说明 |
| merchantId |
商户编号 |
同请求参数 |
| requestId |
商户订单号 |
同请求参数 |
| serialNumber |
交易流水号 |
交易流水号 |
| status |
请求状态 |
SUCCESS 成功 |
| FAILED 失败 |
| ERROR 错误 |
| hmac |
参数签名 |
商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 |
示例
{
"merchantId": "896667346",
"requestId": "205d37ddc32740a9b39b8fd594f7eb4c",
"serialNumber": "2c98a79c9a813d1d019a86be5fc80021",
"status": "SUCCESS",
"hmac": "MbcA+tuwESeC8A1m4mRv4k5ki5A244okDksR0vTDR5nbxnefrJbHpghQ=="
}
异步通知参数列表
| 参数名称 |
参数中文名称 |
参数说明 |
| merchantId |
商户编号 |
同请求参数 |
| requestId |
商户订单号 |
同请求参数 |
| orderAmount |
订单金额 |
订单金额,单位:分 |
| orderCurrency |
订单币种 |
订单币种 |
| paymentModeAlias |
支付方式 |
支付方式 |
| remark |
备注 |
备注 |
| serialNumber |
交易流水号 |
交易流水号 |
| status |
请求状态 |
SUCCESS 成功 |
| FAILED 失败 |
| ERROR 错误 |
| hmac |
参数签名 |
商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 |
示例
{
"merchantId": "896667346",
"requestId": "278e75194c72459ba5264441045397cc",
"orderAmount": "8888",
"orderCurrency": "CNY",
"paymentModeAlias": "FOREIGN-CNY-JSBANK-P2P",
"serialNumber": "2c98a8ee9a75f7c7019a762f0a000004",
"status": "PROCESSING",
"hmac": "P3kPfyI6TVLTzMr8dQk5xYQ2yaZvCseLz3Y9tDa2yPnijjkA49Z8Ju8FncV1VnabQQ=="
}