首信易支付跨境收款下单提交接口用于在商户端选择支付方式“国际银行电汇”后,通讯采用 https 协议,商户通过向首信易支付指定的 URL 发送请求参数数据,接收首信易支付同步返回的下单状态结果及电汇收款账户信息,商户需将收款账户信息银行展示给消费者,引导消费者进行银行电汇。
https://apis.5upay.com/foreignpayExchangesettlement/order
参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
---|---|---|---|---|
merchantId | 商户编号 | varchar(9) | 商户在首信易系统的唯一身份标识,商户完成首信易系统注册后可登录商户后台商户服务查看。 | M |
amount | 订单金额 | varchar(18) | 单位:分,1 元=100 分 | M |
currency | 订单币种 | varchar(3) | USD(美元)、HKD(港币)、JPY(日元)、GBP(英镑)、SGD(新加坡元)、CAD(加元)、AUD(澳大利亚元)、EUR(欧元)、SEK(瑞典克朗)、NOK(挪威克朗)、DKK(丹麦克朗)、MOP(澳门元)、CHF(瑞士法郎) | M |
requestId | 订单号 | varchar(50) | 订单号为商户自行拟定,提交的订单号必须在自身平台交易中唯一。首信易支付系统已付或撤销的订单,商户平台不能以相同的订单号再次提交。 | M |
forUse | 结汇用途 | varchar(50) | GOODSTRADE 货物贸易 | M |
notifyUrl | 通知地址 | varchar(200) | 服务器通知:结汇成功后会向该地址发送成功通知,该地址可以带参数(发送机制见应答机制),如:“https://www.5upay.com/callback.action?test=test”.注意:如不填 notifyUrl 的参数值支付成功后您的服务器将得不到支付成功的通知。 | M |
remark | 备注 | varchar(300) | 商户在首信易为订单进行备注,通过支付结果返回商户 | O |
paymentModeCode | 支付方式编码 | varchar(50) | FOREIGN-FOREX-ECITIC-P2P 国际银行电汇 | C |
productDetails | 商品信息 | Json 数组 | 见下表,商品信息,支持最大上传 50 组商品信息数据 | M |
payer | 支付方信息 | Json | 见下表,支付方信息 | M |
timeout | 订单超时时间 | varchar(10) | 此参数用于设置订单的超时时间(只能设置在 168 小时内)单位小时,如:输入 24,该订单将在 24小时后过期。 | O |
hmac | 参数签名 | varchar(500) | 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 | M |
参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
---|---|---|---|---|
requestId | 商户订单号 | varchar(50) | 商户平台交易订单号(申报到外管平台数据) | M |
name | 商品名称 | varchar(200) | 商品名称 | M |
quantity | 商品数量 | long | 商品数量 | M |
amount | 商品金额 | long | 单位:分,1 元=100 分 | M |
receiver | 收款人 | varchar(200) | 收款人名称(如果为空的话自动取商户在首信易的注册名称) | C |
idType | 收款人证件类型 | varchar(2) | 01 身份证 | C |
02 社会信用统一代 | ||||
idNum | 收款人证件号 | varchar(18) | 收款人证件号 | C |
phoneNum | 收款方电话 | varchar(20) | 收款方电话 | C |
bankCardNum | 收款人银行卡号 | varchar(20) | 收款人银行卡号 | C |
areaCode | 收款方地区编码 | varchar(6) | 收款方地区编码 | C |
attrCode | 经济体类型 | varchar(3) | 见经济体类型 | O |
logisticsNumber | 物流单号 | varchar(120) | 物流单号 | O |
logisticsCompany | 物流公司 | varchar(200) | 物流公司 | O |
invoiceNumber | 发票号 | varchar(35) | 发票号 | O |
contractNumber | 合同号 | varchar(20) | 合同号 | O |
platformName | 平台名称 | varchar(50) | 平台名称 | M |
tradeTime | 交易时间 | varchar(50) | 格式:YYYY-MM-DD HH:MM:SS | M |
参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
---|---|---|---|---|
name | 付款人姓名 | varchar(100) | 付款人姓名 | M |
bankName | 付款银行名称 | varchar(100) | 付款银行名称 | O |
bankCardNum | 付款银行卡号\账户号 | varchar(32) | 付款人电汇银行账户号或银行卡号 | O |
nationality | 付款人国籍 | varchar(3) | 见国家列表 | M |
参数名称 | 参数中文名称 | 参数说明 |
---|---|---|
merchantId | 商户编号 | 商户在首信易系统的唯一身份标识,商户完成首信易系统注册后可登录商户后台商户服务查看。 |
requestId | 订单号 | 订单号为商户自行拟定,提交的订单号必须在自身平台交易中唯一。首信易支付系统已付或撤销的订单,商户平台不能以相同的订单号再次提交。 |
status | 请求状态 | 成功 SUCCESS |
失败 FAILED | ||
错误 ERROR | ||
errorMessage | 失败原因 | 失败原因 |
payee | 国际银行电汇收款账号信息 | 见下表,国际银行电汇收款账号信息 |
hmac | 参数签名 | 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 |
参数名称 | 参数中文名称 | 参数说明 |
---|---|---|
payeeAccountNumber | 收款方账号 | 首信易收款备付金账号,不同币种账户不一样 |
payeeName | 收款方名称 | 首信易备付金账户户名,例:PAYEASE(BEIJING)TECHNOLOGY LTD. |
payeeCountry | 收款方常驻国家(地区) | 收款方常驻国家(地区) |
payeeAddr | 收款方地址 | 收款方地址 |
payeeCurrency | 收款账户币种 | 收款账户币种 |
payeeBankName | 收款银行名称 | 收款银行名称 |
payeeBankSwift | 收款银行SWIFT | 收款银行SWIFT |
payeeBankAddr | 收款银行地址 | 收款银行地址 |
postscript | 汇款附言 | 首信易按订单生成唯一数字编号,买家进行线下银行电汇时,需要买家将此编号填写在银行汇款附言中 |
参数名称 | 参数中文名称 | 参数说明 |
---|---|---|
merchantId | 商户编号 | 商户在首信易系统的唯一身份标识,商户完成首信易系统注册后可登录商户后台商户服务查看。 |
requestId | 订单号 | 订单号为商户自行拟定,提交的订单号必须在自身平台交易中唯一。首信易支付系统已付或撤销的订单,商户平台不能以相同的订单号再次提交。 |
serialNumber | 交易流水号 | 首信易系统交易流水号 |
currency | 订单币种 | 见货币列表 |
amount | 订单金额 | 订单金额,单位为分 |
remark | remark | 商户在首信易为订单进行备注,通过支付结果返回商户 |
foreignExchange | 结汇信息JSON | 见下表,结汇信息 |
paymentModeAlias | 支付方式 | FOREIGN-FOREX-ECITIC-P2P 国际银行电汇 |
hmac | 参数签名 | 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 |
参数名称 | 参数中文名称 | 参数说明 |
---|---|---|
amount | 结汇金额 | 单位:分,1元=100分 |
currency | 结汇币种 | 默认CNY |
status | 结汇状态 | 成功SUCCESS,结汇成功 |
失败FAILED | ||
失败FAILED, | ||
listprice | 交易牌价 | 商户牌价 |
completeDateTime | 结汇完成时间 | 结汇完成时间 |