预创建订单
客户在商户平台登录后,在点击支付时,商户平台将支付信息以及发票信息传输到荣e通平台,然后荣e通平台验证成功后向商户返回跳转连接地址,商户平台根据地址跳转到荣e通页面,该页面同时展示出客户提交的订单信息,包括纳订单金额、订单编号、收款人。收款人开户行、收款人账号等相关信息。
请求地址
环境 | 请求地址 |
正式环境 | https://api.cargonpay.com/api/apiJoinPay/orderSubmit |
请求参数
索引 | ID | 名称 | 类型及长度 | 必须 | 说明 | |
1 | accessKey | 请求唯一标识 | varchar(36) | 是 | 荣e通平台为商户分配 | |
2 | nonce | 随机号 | varchar(36) | 是 | ||
3 | timestamp | 时间戳 | varchar(20) | 是 | Unix时间戳,保留到毫秒 | |
4 | sign | 签名 | varchar(32) | 是 | ||
5 | returnUrl | 支付提交完成后返回页面 | varchar(200) | 是 | ||
6 | notifyUrl | 支付结果通知地址 | varchar(200) | 是 | ||
7 | detail | 付款信息 | object | 是 | ||
8 | merchantOrderNo | 商户订单号 | varchar(36) | 是 | ||
9 | currency | 发票币别 | varchar(10) | 是 | USD、CNY | |
10 | paymentAmount | 订单金额 | decimal(18,2) | 是 | ||
11 | shipName | 船名 | varchar(50) | 否 | ||
12 | voyage | 航次 | varchar(100) | 否 | ||
13 | billNo | 提单号 | varchar(200) | 否 | ||
14 | shipDate | 开船日 | varchar(20) | 否 | 例:yyyy-MM-dd | |
15 | billFile | 提单影像 | varchar | 否 | Base64字符串(PDF) | |
16 | pdfFile | 发票文件 | array | 是 | ||
17 | invoiceNo | 发票号码 | varchar(10) | 是 | 币别为USD时必填,为CNY时选填 | |
18 | invoiceType | 发票类型 | varchar(10) | 是 | 币别为USD时必填,为CNY时选填电票:PDF纸票:JPG | |
19 | invoiceAmount | 发票金额 | decimal(18,2) | 是 | ||
20 | invoiceFile | 发票文件 | varchar | 是 | 币别为USD时必填,为CNY时选填发票文件Base64String | |
21 | bankAccount | 收款账户 | varchar(30) | 否 | 空默认使用收款默认账号 |
响应参数
索引 | ID | 名称 | 长度 | 必须 | 说明 |
1 | code | 返回状态码 | varchar(10) | 是 | |
2 | message | 返回消息 | varchar(200) | 是 | |
3 | data | object | 是 | ||
4 | url | 支付跳转页面 | nvarhcar(200) | 是 | |
5 | tradeNo | 交易号 | varchar(36) | 是 | |
6 | merchantOderNo | 商户订单号 | varchar(36) | 是 |
请求示例
JSON格式
{ "timestamp": "1725797231000", "nonce": "1725797231052", "accessKey": "F0D16DD2EFF945C4B73A4B37F99C2696", "sign": "AB15D04C25F6B63317F2C166B58EED61", "returnUrl": "http://www.xxx.com/xx", "notifyUrl": "http://www.xxx.com/xxx", "detail": { "merchantOrderNo": "7123847812", "currency": "USD", "paymentAmount": 10780, "shipName": "测试", "voyage": "测试", "billNo": "871283718", "shipDate": "2021-06-23", "billFile": "base64string", "pdfFile": [ { "invoiceNo": "81237123", "bankAccount": "32423423423423", "invoiceType": "PDF", "invoiceAmount": 10780, "invoiceFile": "base64string" } ] } }
复制代码
响应示例
JSON格式
{ "code": "000000", "message": "请求成功", "data": { "url": "https://www.x.com/pxxxx?orderCodes=[B@803a333", "tradeNo": "ADV21071211053249592", "merchantOrderNo": "7123847812" } }
复制代码
返回码说明
索引 | id | 名称 |
1 | 000000 | 提交成功 |
2 | 100001 | 参数无效,【参数名】不正确 |
3 | 100002 | 请求时间超出有效时间 |
4 | 100003 | 商户accessKey不存在,请联系荣e通客服 |
5 | 100004 | 商户accessKey已停用 |
6 | 100005 | 验证签名失败 |
7 | 100006 | 请求重复,请重新发起(nonce重复) |
8 | 200001 | 订单总金额与发票总金额不一致 |
9 | 200005 | 商户未设置默认的收款账号 |
10 | 999999 | 系统错误,请联系技术人员 |
11 | 200006 | 未查询到收款账号信息 |
12 | 200007 | 收款账号币别与订单币别不一致 |
- 请求地址
- 请求参数
- 响应参数
- 请求示例
- 响应示例
- 返回码说明