跳至主要內容

代付订单 · 墨西哥

TOPPAY Team大约 5 分钟

请求

代付 API 用于向受益人发起代付交易。本页为 墨西哥(国家码 mx)的代付说明。代付走 SPEI 时,bankCode 为参与机构 数字编码bankCard 常为收款人 CLABE(18 位) 等账户标识;完整机构码与名称见 地区支付说明 — 墨西哥

请求路径

域名:推荐使用统一域名 openapi.toppayment.com(路径不变);原国别域名(如 global-mx-openapi.toppayment.com)仍可用。

环境地址
沙箱https://openapi.toppayment.com/sandbox/mx/disbursement/cash
生产https://openapi.toppayment.com/mx/disbursement/cash

代付 bankCode / bankName(SPEI 机构)地区支付说明 — 墨西哥

请求头

字段必填类型描述
Content-TypeMStringHTTP内容类型规范
固定值:application/json
正确解析请求所必需

请求体

字段必填类型描述
mchNoMString(32)商户编号
平台分配的唯一商户标识符
用于商户认证和交易路由
orderNumMString(50)商户订单号
唯一交易标识符
格式:字母数字字符串
用于交易跟踪和参考
amountMNumber(32,8)交易金额
格式:数值类型
示例:100.50
墨西哥地区:须为正数,整数或最多两位小数,不允许全为 0,不允许三位及以上小数。
bankCodeMString(32)SPEI 收款机构 数字编码(墨西哥)
地区支付说明 — 墨西哥 中「SPEI 参与机构」
bankCardMString(50)收款账户标识
常见为 CLABE(18 位数字) 等,格式以实际网关与收款行要求为准
accountNameMString(50)账户名
收款人账户名称
格式:UTF-8编码字符串
descriptionOString(255)描述
交易目的或描述
格式:UTF-8编码字符串
feeTypeMNumber(0或1)手续费类型
0 : 代付金额内扣除(实际到账金额=下单金额-手续费)
1 : 手续费另计(实际到账金额=下单金额)
downNotifyUrlMString(164)异步通知地址
交易状态更新的Webhook通知URL
格式:有效的HTTP/HTTPS URL
用于实时交易状态通知
timestampMString(13位数字)时间戳
请求时间戳
示例:1749451858772
signMString签名
请求认证的数字签名
参见签名生成

请求体示例 – 付款请求(示例为 BBVA MEXICO 40012 + CLABE 占位;以实际网关为准):

Content-type: application/json

响应

HTTP响应

字段必填类型描述
Content-TypeMStringHTTP响应内容类型规范
固定值:application/json
指示JSON响应格式

响应字段

字段必填类型描述
successMBoolean请求是否成功
true:成功,false:失败
codeMString响应状态码
9999:成功
其他:请根据订单状态码判断,不能直接处理订单失败,以免造成资金损失
msgOString响应消息
可读的响应状态描述
包含订单详细信息
timeStampMNumber响应时间戳
服务器响应时间(毫秒级)
dataMObject响应数据对象
包含交易详细信息
orderNumMString商户订单号
与请求中提供的orderNum相同
用于交易跟踪和参考
platOrderNumMString平台订单号
系统生成的内部交易参考号
用于内部交易管理和支持
amountMNumber交易金额
确认的交易金额
feeMNumber手续费
交易产生的手续费
feeTypeMNumber手续费类型
1:商户承担手续费
statusMNumber交易状态
订单当前处理状态码
statusMsgMString状态消息
订单状态的文字描述
bankCodeMStringSPEI 机构编码(墨西哥)
含义见 地区支付说明 — 墨西哥
bankCardMString银行卡号/账户号
收款人的银行账户号码或钱包账号
accountNameMString账户名
收款人账户名称
descriptionOString描述
交易目的或描述

响应示例

Content-type: application/json

通知

HTTP请求

字段必填类型描述
Content-TypeMStringHTTP请求内容类型规范
固定值:application/json
指示JSON请求格式

通知体

字段必填类型描述
platOrderNumMString平台订单号
系统生成的内部交易参考号
用于内部交易管理和支持
versionMString版本号
接口版本标识
示例:v1
orderNumMString商户订单号
与原始请求中提供的orderNum相同
用于交易识别和验证
amountMNumber交易金额
确认的交易金额
feeMNumber手续费
交易产生的手续费
feeTypeMNumber手续费类型
1:商户承担手续费
statusMNumber交易状态
取值见 交易状态码
statusMsgMString状态消息
订单状态的文字描述
bankCodeMStringSPEI 机构编码(墨西哥)
地区支付说明 — 墨西哥
bankCardMString银行卡号/账户号
accountNameMString账户名
descriptionOString描述
signMString签名
回调数据的数字签名

返回

重要响应

通知响应: 请仅返回字符串SUCCESS以确认收到通知

{
    "platOrderNum": "TRANS2008812168572567552",
    "version": "v1",
    "orderNum": "MXPAYOUT12345648",
    "amount": 111.00,
    "fee": 3,
    "feeType": 1,
    "status": 2,
    "statusMsg": "supplement success!",
    "bankCode": "40012",
    "bankCard": "012345678901234567",
    "accountName": "Luis Garcia",
    "description": "test",
    "sign": "KCitZCmhtuoGtVOl/EC4Mn1vwf3QRkoL9Ged0psKiCzATvP0AePNc8P1PEcWrbJYAPctewCRO9jW+vHjtXrh6ozk2OUvVDUlLTiM3PS7ydpeogy+W6w3b4OZDg5vUtaTVwz5mpEKBZv/XEhOes1C16+ec36PLp3Mi0Y0g4ivgwk="
}