代收接口
代收下单
调用此接口发起支付请求,成功将返回订单信息。
- 请求方法:POST
- 接口路径:http://接口域名/api/v1/mch/pmt-orders
- 请求参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mch_id | number | ✅ | 商户 ID,请在商户后台配置中查看 |
| trans_id | string | ✅ | 商户交易 ID,由商户提供 |
| currency | string | ✅ | 币种代码,参见系统货币代码 |
| amount | string | ✅ | 订单金额,法币标准单位,越南金额为整数。⚠️:使用字符串传递,比如 100.00,传递 "100.00" |
| channel | string | ✅ | 通道代码,对接测试使用 mock。其他各国通道代码参见系统通道代码 |
| bank_code | string | ⭕️ | 特定通道需要提供,对接时会特别说明 |
| payer_account_no | string | ⭕️ | (实名场景使用)付款账号 |
| payer_account_name | string | ⭕️ | (实名场景使用)付款人姓名 |
| payer_account_org | string | ⭕️ | (实名场景使用)付款机构名称 |
| callback_url | string | ✅ | 支付成功后平台将以 HTTP POST 方式通知支付结果 |
| mode | string | ⭕️ | 模式,auto 或 manual。选择 auto(默认)时自动分配收款账号,manual 需要玩家自行选择收款银行才会出现收款账号 |
| return_url | string | ⭕️ | 支付成功后平台将跳转到此页面 |
| uid | string | ⭕️ | 用户 ID。可使用贵方系统用户 ID 或其 MD5 值。若是 USDT 通道,此值必传 |
| remarks | string | ⭕️ | 订单备注,回调时原样返回 |
| nonce | string | ✅ | 随机字符串,至少 6 位 |
| timestamp | string | ✅ | UNIX 时间戳,10 位 |
| sign | string | ✅ | 参数签名。参见签名算法 |
- 返回结果
| 参数名 | 类型 | 说明 |
|---|---|---|
| id | string | 平台唯一订单 ID |
| mch_id | number | 商户 ID |
| trans_id | string | 交易 ID |
| order_amount | number | 订单金额 |
| channel | string | 支付通道代码 |
| status | number | 订单状态,新创建的订单为 20 |
| url | string | 订单 URL(H5 页面,可直接展示给最终支付用户) |
| cashier_type | number | 收银台类型,参见"cashier_type 说明" |
| meta | object | (越南 bank 通道专用)原始收款账号,内容参见下方 |
| meta.account_no | string | (越南 bank 通道专用)收款账号 |
| meta.account_name | string | (越南 bank 通道专用)收款姓名 |
| meta.account_org | string | (越南 bank 通道专用)收款机构名称 |
| meta.account_org_code | string | (越南 bank 通道专用)收款机构代码 |
| meta.qr_url | string | (越南 bank 通道专用)越南银行二维码 |
- cashier_type 说明
0 表示返回值仅有收银页面链接, 参见上面的 url 字段 1 表示返回值仅有收款账号信息,参见上面的 meta 字段 9 表示既有 url 又有 meta 字段。默认情况下,可以直接使用 url 获取收银台链接。若要使用自定义收银台,可使用 meta 字段中的收款账号信息
响应示例
json
{
"code": 200,
"payload": {
"id": "ET1729187424AJCT",
"mch_id": "8888",
"trans_id": "商户提交的订单号/交易ID",
"channel": "bank",
"order_amount": 101,
"status": 20,
"cashier_type": 9,
"url": "http://cashier.money.com/cashier/order?id=abcdefg123",
"meta": {
"account_no": "898123767665",
"account_name": "THAN NHA TRONG",
"account_org": "CIMB",
"account_org_code": "422589"
},
"sign": "e0c0a5a0c5ddeb3f3887e273df49568b"
}
}支付成功后,系统会向平台发送通知,查看代收回调说明。
代收订单查询
- 请求方法:GET
- 接口路径:http://接口域名/api/v1/mch/pmt-orders
- 请求示例:http://接口域名/api/v1/mch/pmt-orders?id=订单号&mch_id=商户号&sign=参数签名
- 请求参数:
| 参数名 | 必填 | 说明 |
|---|---|---|
| id | ✅ | 订单 ID 或交易 ID。请注意,此参数也要参与签名 |
| mch_id | ✅ | 商户 ID,请在商户后台配置中查看 |
| nonce | ✅ | 随机字符串,至少 6 位 |
| timestamp | ✅ | UNIX 时间戳,10 位 |
| sign | ✅ | 参数签名。参见签名算法 |
- 返回结果:
| 参数名 | 说明 |
|---|---|
| id | 平台唯一订单 ID |
| mch_id | 商户 ID |
| trans_id | 交易 ID |
| order_amount | 订单金额 |
| payed_amount | 实付金额,请注意若与下单金额不匹配时,请务确定要不要上分 |
| channel | 支付通道代码 |
| status | 状态,60 表示支付成功,其他未支付 |
| created_at | 创建时间 |
响应示例
json
{
"code": 200,
"payload": {
"id": "EOu154sgKfZB",
"mch_id": "8888",
"trans_id": "商户的交易ID",
"amount": 100,
"channel": "bank",
"status": 20,
"url": "http://cashier.money.com/cashier/order?id=abcdefg123",
"sign": "e0c0a5a0c5ddeb3f3887e273df49568b",
"created_at": "2020-09-09 12:21:44"
}
}