代收订单 · 巴基斯坦
大约 3 分钟
请求
代收 API 用于向客户发起代收交易。本页为 巴基斯坦(国家码 pk)的代收说明。
- 金额单位为 PKR 整数(无小数),单笔 50 ~ 50,000。
method及补充参数见 地区支付说明 — 巴基斯坦。
请求路径
域名:推荐使用统一域名
openapi.toppayment.com(路径不变);原国别域名(如global-pk-openapi.toppayment.com)仍可用。
| 环境 | 地址 |
|---|---|
| 沙箱 | https://openapi.toppayment.com/sandbox/pk/pay/prePay |
| 生产 | https://openapi.toppayment.com/pk/pay/prePay |
请求头
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | 固定值:application/json |
请求体
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| mchNo | M | String(32) | 商户编号 |
| orderNum | M | String(64) | 商户订单号 |
| amount | M | Number | 交易金额(PKR 整数,50–50000) |
| productDetail | M | String(100) | 产品详情 |
| method | M | String(16) | 支付方式,见 巴基斯坦代收编码 |
| timestamp | M | String(13) | 时间戳(毫秒) |
| customerName | M | String(64) | 客户姓名 |
| customerEmail | M | String(64) | 客户邮箱 |
| customerPhone | M | String(32) | 客户电话 |
| documentNo | C | String(100) | 13 位 CNIC;method=EASYPAISA 时 必填 |
| downNotifyUrl | M | String(255) | 异步通知地址 |
| redirectUrl | O | String(512) | 支付完成重定向地址(收银台) |
| sign | M | String | 签名,见 签名生成 |
请求体示例
Content-type: application/json
{
"mchNo": "{{mchNo}}",
"orderNum": "PK1234561",
"amount": 500,
"productDetail": "测试商品",
"method": "EASYPAISA",
"timestamp": "1749451858772",
"customerName": "Ali Khan",
"customerEmail": "[email protected]",
"customerPhone": "03001234567",
"documentNo": "3520212345671",
"downNotifyUrl": "https://example.com/notify",
"redirectUrl": "https://example.com/return",
"sign": "按签名规则生成后替换"
}
响应字段
method 含义见 地区支付说明 — 巴基斯坦。
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| success | M | Boolean | 请求是否成功 |
| code | M | String | 9999:成功 |
| msg | O | String | 响应消息 |
| timeStamp | M | Number | 响应时间戳(毫秒) |
| data | M | Object | 交易数据 |
| orderNum | M | String | 商户订单号 |
| platOrderNum | M | String | 平台订单号 |
| amount | M | Number | 交易金额(PKR 整数) |
| fee | M | Number | 手续费 |
| method | M | String | 支付方式,见 地区支付说明 — 巴基斯坦 |
| productDetail | M | String | 产品详情 |
| customerName | M | String | 客户姓名 |
| customerEmail | M | String | 客户邮箱 |
| customerPhone | M | String | 客户电话 |
| validTime | M | Number | 过期时间戳(毫秒) |
| cashierUrl | M | String | 收银台 URL |
响应示例
{
"success": true,
"code": "9999",
"msg": null,
"timeStamp": 1767840272829,
"data": {
"orderNum": "PK1234561",
"platOrderNum": "PRE2009093829059153920",
"amount": 500,
"fee": 10,
"method": "EASYPAISA",
"productDetail": "测试商品",
"customerName": "Ali Khan",
"customerEmail": "[email protected]",
"customerPhone": "03001234567",
"validTime": 1767926672819,
"cashierUrl": "https://example.cashier/pay"
}
}
通知
巴基斯坦地区异步通知使用默认版本,version 固定为 v1。
HTTP请求
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | 固定值:application/json |
通知体
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| platOrderNum | M | String | 平台订单号 |
| version | M | String | 版本号,固定为 v1 |
| orderNum | M | String | 商户订单号,与下单时的 orderNum 相同 |
| amount | M | Number | 交易金额(PKR 整数) |
| fee | M | Number | 手续费 |
| customerName | M | String | 客户姓名 |
| customerEmail | M | String | 客户邮箱 |
| customerPhone | M | String | 客户电话 |
| status | M | String | 交易状态 取值见 交易状态码 |
| sign | M | String | 回调签名,见 签名生成 |
返回
校验签名后,仅返回字符串 SUCCESS。
SUCCESS
通知示例
{
"platOrderNum": "PRE2009165141186183168",
"version": "v1",
"orderNum": "PK1234561",
"amount": 500,
"fee": 10,
"customerName": "Ali Khan",
"customerEmail": "[email protected]",
"customerPhone": "03001234567",
"status": "SUCCESS",
"sign": "按签名规则校验"
}
