代收订单 · 墨西哥
大约 7 分钟
概述
代收 API 用于向客户发起代收交易。本页为 墨西哥（国家码 mx）的代收能力说明，支持以下两种下单方式：
| 下单方式 | 路径 | 说明 |
|---|---|---|
| 收银台模式 | /pay/prePay | 默认模式，返回 cashierUrl，用户跳转平台 H5 收银台完成支付 |
| API 模式 | /pay/transOrder | 请求中指定 method，直接返回 payData / payDataType（CLABE、二维码、跳转链接等） |
method（墨西哥代收方式编码）见 地区支付说明 — 墨西哥。
接入说明
默认开通收银台模式。如需对接 API 模式，请联系客服申请商户白名单后再集成。
请求头
两种模式共用：
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | HTTP内容类型规范 固定值：application/json 正确解析请求所必需 |
收银台模式（prePay）
商户预下单后获取 cashierUrl，引导用户至平台收银台选择支付方式并完成付款。
请求路径
域名：推荐使用统一域名
openapi.toppayment.com（路径不变）；原国别域名（如global-mx-openapi.toppayment.com）仍可用。
| 环境 | 地址 |
|---|---|
| 沙箱 | https://openapi.toppayment.com/sandbox/mx/pay/prePay |
| 生产 | https://openapi.toppayment.com/mx/pay/prePay |
请求体
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| mchNo | M | String(32) | 商户编号 平台分配的唯一商户标识符 用于商户认证和交易路由 |
| orderNum | M | String(64) | 商户订单号 唯一交易标识符 格式：字母数字字符串 用于交易跟踪和参考 |
| amount | M | Number(32,8) | 交易金额 格式：数值类型 正数，整数或最多两位小数，不允许全为 0，不允许三位及以上小数 示例：100.50 |
| productDetail | M | String (100) | 产品详情 交易目的或描述 格式：UTF-8编码字符串 |
| method | O | String (16) | 支付方式（墨西哥） 可选；不传则用户在收银台选择。常用 SPEI；亦支持 CODI、OXXO，详见 地区支付说明 — 墨西哥 |
| timestamp | M | String(13) | 时间戳 请求时间戳（毫秒级） 示例：1749451858772 |
| customerName | M | String (64) | 客户姓名 付款人姓名 格式：UTF-8编码字符串 |
| customerEmail | M | String (64) | 客户邮箱 付款人邮箱地址 格式：有效的邮箱格式 |
| customerPhone | M | String (32) | 客户电话 付款人电话号码 格式：有效的电话号码 |
| expiryPeriod | O | Number(1-9999) | 过期时间 交易过期时间（分钟） 示例：1440（24小时） 用于设置交易有效期 |
| downNotifyUrl | M | String(255) | 异步通知地址 交易状态更新的Webhook通知URL 格式：有效的HTTP/HTTPS URL 用于实时交易状态通知 |
| redirectUrl | O | String(512) | 重定向地址 支付完成后客户重定向URL 格式：有效的HTTP/HTTPS URL 用于支付处理后重定向客户 |
| sign | M | String | 签名 请求认证的数字签名 参见签名生成 |
请求体示例
Content-type: application/json
{
"mchNo": "{{mchNo}}",
"orderNum": "MX1234561",
"amount": 100.50,
"productDetail": "测试商品",
"method": "SPEI",
"timestamp": "1749451858772",
"customerName": "Juan Garcia",
"customerEmail": "[email protected]",
"customerPhone": "+5255123456789",
"expiryPeriod": 1440,
"downNotifyUrl": "https://example.com/notify",
"redirectUrl": "https://example.com/return",
"sign": "按签名规则生成后替换"
}
响应字段
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| success | M | Boolean | 请求是否成功 true：成功，false：失败 |
| code | M | String | 响应状态码 9999：成功 其他：失败 |
| msg | O | String | 响应消息 可读的响应状态描述 成功时为null |
| timeStamp | M | Number | 响应时间戳 服务器响应时间（毫秒级） |
| data | M | Object | 响应数据对象 包含交易详细信息 |
| orderNum | M | String | 商户订单号 与请求中提供的orderNum相同 用于交易跟踪和参考 |
| platOrderNum | M | String | 平台订单号 系统生成的内部交易参考号 用于内部交易管理和支持 |
| amount | M | Number | 交易金额 确认的交易金额 |
| 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 用于跳转支付的收银台地址 |
响应说明
收银台模式不返回 payData、payDataType；支付凭证字段仅见于 API 模式 响应。
响应示例
Content-type: application/json
{
"success": true,
"code": "9999",
"msg": null,
"timeStamp": 1767840272829,
"data": {
"orderNum": "MX1234561",
"platOrderNum": "PRE2009093829059153920",
"amount": 100.50,
"fee": 2.0,
"method": "SPEI",
"productDetail": "测试商品",
"customerName": "Juan Garcia",
"customerEmail": "[email protected]",
"customerPhone": "+5255123456789",
"validTime": 1767926672819,
"cashierUrl": "https://example.cashier/pay"
}
}
API 模式（transOrder）
商户在请求中指定支付方式后，直接向支付通道发起交易，并在响应中返回 payData / payDataType（如 SPEI 收款 CLABE、CoDi 二维码、OXXO 支付页链接等），无需跳转平台 H5 收银台。
请求路径
| 环境 | 地址 |
|---|---|
| 沙箱 | https://openapi.toppayment.com/sandbox/mx/pay/transOrder |
| 生产 | https://openapi.toppayment.com/mx/pay/transOrder |
请求体
与收银台模式相比，差异如下：
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| method | M | String(16) | 支付方式（墨西哥） API 模式必传。常用 SPEI、CODI、OXXO，详见 地区支付说明 — 墨西哥 |
其余字段与收银台模式相同。
请求体示例
Content-type: application/json
{
"mchNo": "{{mchNo}}",
"orderNum": "MXAPI1234561",
"amount": 100.50,
"productDetail": "测试商品",
"method": "SPEI",
"timestamp": "1749451858772",
"customerName": "Juan Garcia",
"customerEmail": "[email protected]",
"customerPhone": "+5255123456789",
"expiryPeriod": 1440,
"downNotifyUrl": "https://example.com/notify",
"sign": "按签名规则生成后替换"
}
{
"mchNo": "{{mchNo}}",
"orderNum": "MXAPI7890121",
"amount": 100.50,
"productDetail": "测试商品",
"method": "CODI",
"timestamp": "1749451858772",
"customerName": "Juan Garcia",
"customerEmail": "[email protected]",
"customerPhone": "+5255123456789",
"expiryPeriod": 1440,
"downNotifyUrl": "https://example.com/notify",
"sign": "按签名规则生成后替换"
}
响应字段
公共响应字段（success、code、msg、timeStamp 及 data 中的 orderNum、platOrderNum、amount、fee、method、productDetail、customerName、customerEmail、customerPhone、validTime）与收银台模式相同。API 模式重点关注：
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| payData | M | String | 支付数据 CLABE 账号、CoDi 二维码内容、OXXO 支付页链接等，具体含义由 payDataType 决定 |
| payDataType | M | String | 支付数据类型 取值： VA、QR_CODE、CASHIER_URL 等 |
payDataType 说明
| payDataType | 说明 | 典型 method |
|---|---|---|
VA | 虚拟账号 / CLABE，商户引导用户向该账号转账 | SPEI |
QR_CODE | 二维码内容字符串，需自行渲染为二维码 | CODI |
CASHIER_URL | 上游支付页跳转链接 | OXXO |
响应示例
Content-type: application/json
{
"success": true,
"code": "9999",
"msg": null,
"timeStamp": 1767840272829,
"data": {
"orderNum": "MXAPI1234561",
"platOrderNum": "PRE2009093829059153920",
"amount": 100.50,
"fee": 2.0,
"method": "SPEI",
"productDetail": "测试商品",
"customerName": "Juan Garcia",
"customerEmail": "[email protected]",
"customerPhone": "+5255123456789",
"validTime": 1767926672819,
"payData": "646180157000000004",
"payDataType": "VA"
}
}
{
"success": true,
"code": "9999",
"msg": null,
"timeStamp": 1767840272829,
"data": {
"orderNum": "MXAPI7890121",
"platOrderNum": "PRE2009093829059153921",
"amount": 100.50,
"fee": 2.0,
"method": "CODI",
"productDetail": "测试商品",
"customerName": "Juan Garcia",
"customerEmail": "[email protected]",
"customerPhone": "+5255123456789",
"validTime": 1767926672819,
"payData": "00020101021226650016COM.MX.CODI...",
"payDataType": "QR_CODE"
}
}
通知
两种下单方式的异步通知一致。墨西哥地区回调固定为 v1 格式，不支持 notifyVersion / v2 付款人扩展字段。
SPEI 等场景下同一 orderNum 可能收到多笔成功回调，规则见 地区支付说明 — 墨西哥 中「代收通知规则」。
HTTP请求
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | HTTP请求内容类型规范 固定值：application/json 指示JSON请求格式 |
通知体
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| platOrderNum | M | String | 平台订单号 系统生成的内部交易参考号 用于内部交易管理和支持 |
| version | M | String | 版本号 固定为 v1 |
| orderNum | M | String | 商户订单号 与原始请求中提供的orderNum相同 用于交易识别和验证 |
| amount | M | Number | 交易金额 确认的交易金额 |
| fee | M | Number | 手续费 交易产生的手续费 |
| customerName | M | String | 客户姓名 付款人姓名 |
| customerEmail | M | String | 客户邮箱 付款人邮箱地址 |
| customerPhone | M | String | 客户电话 付款人电话号码 |
| status | M | String | 交易状态 取值见 交易状态码 指示交易的最终状态 |
| sign | M | String | 签名 回调数据的数字签名 用于验证回调数据的真实性 |
返回
重要响应
通知响应： 请仅返回字符串
SUCCESS以确认收到通知
{
"platOrderNum": "PRE2009165141186183168",
"version": "v1",
"orderNum": "MX12345621",
"amount": 100.50,
"fee": 2,
"customerName": "Juan Garcia",
"customerEmail": "[email protected]",
"customerPhone": "+5255123456789",
"status": "SUCCESS",
"sign": "…"
}
SUCCESS