明细校验接口

功能概述

首信易支付跨境收款明细校验接口,商户通过向首信易支付指定的 URL 发送请求参数数据,接收首信易支付同步返回的明细校验结果

接口地址

https://apis.5upay.com/foreignpayExchangesettlement/batch/validate

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(9) 商户在首信易系统的唯一身份标识,商户完成首信易系统注册后可登录商户后台商户服务查看。 M
requestId 订单号 varchar(50) 订单号为商户自行拟定,提交的订单号必须在自身平台交易中唯一。首信易支付系统已付或撤销的订单,商户平台不能以相同的订单号再次提交。 M
amount 金额 varchar(18) 订单金额,单位:分,1 元=100 分 M
creditedCurrency 到账币种 varchar(3) 到账币种 M
foreignpayBusinessType 业务类型 varchar(50) GOODSTRADE 货物贸易 M
notifyUrl 通知地址 varchar(200) 服务器通知:结汇成功后会向该地址发送成功通知,该地址可以带参数(发送机制见应答机制),如:“https://www.5upay.com/callback.action?test=test”.注意:如不填 notifyUrl 的参数值支付成功后您的服务器将得不到支付成功的通知。 M
detailPath 上传明细地址 varchar(500) 上传明细地址 调用此接口前需要先上传明细文件到首信sftp服务器
sftp账号申请方式:见开发者服务-sftp数据传输说明
sftp上传路径:/foreignpay/, 在此目录下可创建子目录
模板文件:Goods_Trade_FX_Payment_Details_Template.xlsx
M
hmac 参数签名 varchar(500) 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 M

示例

{ "merchantId": "896667346", "requestId": "06c95824a6254c8eb0ff204a6f3f4781", "amount": 99993000, "creditedCurrency": "CNY", "foreignpayBusinessType": "GOODSTRADE", "notifyUrl": "https://open.payeasenet.com/notify.php", "detailPath": "/foreignpay/20251115/06c95824a6254c8eb0ff204a6f3f4781.xlsx", "hmac": "JLT2UejjayBdZCWSlqBAmFhyIePyn2jzuarScAm/ZWpUsXTw==" }

订单同步返回参数列表

参数名称 参数中文名称 参数说明
merchantId 商户编号 同请求信息
requestId 订单号 同请求信息
validateId 校验号 首信易系统校验号
creditedCurrency 到账货币 到账货币 CNY
status 状态 SUCCESS
ERROR
FAILED
hmac 参数签名 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程

示例

{ "merchantId": "896667346", "requestId": "ea2f9a9543ea4b8ab869f4a220ef315a", "validateId": "2c98a92f9a7c7a4d019a80393b0a000c", "creditedCurrency": "CNY", "status": "SUCCESS", "hmac": "svIfPI+oy3RCJNIdozvNIFHGKETSCelJHcxv3XRIFp+b3ZM/QTw==" }

订单异步返回参数列表

参数名称 参数中文名称 参数说明
failDetailPath 失败详情sftp下载路径 此字段有值时,值为失败详情sftp下载路径
merchantId 商户编号 同请求信息
requestId 订单号 同请求信息
validateId 校验号 首信易系统校验号
creditedCurrency 到账货币 到账货币 CNY
status 状态 SUCCESS
ERROR
FAILED
hmac 参数签名 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程

示例

{ "failDetailPath": "/foreignpay/details/errorfile/20251113/fail_8a808b671e7c49a08e57a43a9bd50d1e.xlsx", "merchantId": "896667346", "requestId": "8a808b671e7c49a08e57a43a9bd50d1e", "validateId": "2c98a75c9a7c7b53019a7d086764000c", "creditedCurrency": "CNY", "status": "FAILED", "hmac": "mSKaITh5zbQZ+vFV4eUkFX9q80b+XnGnoubKvw==" }