API 付款交易

请求

付款API使商户能够发起向各种收款人（包括员工、客户、供应商和合作伙伴）的付款交易。此API支持多种支付方式，用于在墨西哥市场进行安全高效的转账。

请求路径：

沙盒环境：https://sandbox-gateway.smilepayz.com/v2.0/disbursement/pay-out
生产环境：https://gateway.smilepayz.com/v2.0/disbursement/pay-out

请求头参数

字段	必填	类型	描述
Content-Type	是	String	HTTP内容类型规范固定值：application/json 正确解析请求所必需
X-TIMESTAMP	是	String	ISO 8601日期时间格式，带时区偏移格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-06:00 注意：必须是当前服务器时间，误差在±5分钟内
X-SIGNATURE	是	String	请求认证的数字签名参见签名生成
X-PARTNER-ID	是	String	平台分配的唯一商户标识符格式：字母数字字符串用于商户认证和交易路由请输入merchantID

请求体参数

字段	必填	类型	描述
orderNo	是	String(32)	唯一交易标识符格式：字母数字字符串（仅数字和字母）长度：6-32个字符用于交易跟踪和参考
purpose	是	String(64)	交易目的或描述格式：UTF-8编码字符串最大长度：64个字符用于交易识别和报告
merchant	是	Object	商户信息容器包含商户识别和业务详情参见商户模型
merchantId	是	String	平台分配的唯一商户标识符格式：字母数字字符串用于商户认证和交易路由
merchantName	否	String	商户业务名称或显示名称格式：UTF-8编码字符串用于商户识别和报告
subMerchantId	否	String	多级商户结构的子商户标识符格式：字母数字字符串用于子商户识别和报告
subMerchantName	否	String	子商户业务名称或显示名称格式：UTF-8编码字符串用于子商户识别和报告
money	是	Object	交易金额详情，包含货币规格包含交易金额和货币信息参见货币模型
currency	是	String	ISO 4217货币代码规范固定值：MXN（墨西哥比索）确定支付处理规则和结算货币
amount	是	Number	最小货币单位的交易金额格式：整数值示例：20000表示MXN 20000 范围：100-999999999
paymentMethod	是	String(6)	用于交易处理的支付方式格式：预定义支付方式代码示例：BANXICO, BANAMEX, BBVAMX, SANTANDER 指示实际使用的支付渠道参见支付方式列表
cashAccount	是	String(32)	墨西哥银行账户号码格式：字母数字字符串最大长度：32个字符用于资金转账目的地
callbackUrl	否	String(256)	交易状态更新的Webhook通知URL 格式：有效的HTTP/HTTPS URL 最大长度：256个字符用于实时交易状态通知

重要说明

1. 交易ID： orderNo必须在商户的所有交易中唯一
2. 金额格式： 金额应以最小货币单位提供（MXN的分为单位）
3. 时区： 所有时间戳使用墨西哥时区（UTC-6）
4. 银行账户： 必须是有效的墨西哥银行账户号码
5. 支付方式： 支持所有主要墨西哥银行和金融机构

请求体示例 – 付款请求：

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-06:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
  "orderNo": "2000102900000000000001",
  "paymentMethod": "BANXICO",
  "purpose": "2024年3月工资支付",
  "additionalParam": {},
  "cashAccount": "17385238451",
  "merchant": {
    "merchantId": "20001"
  },
  "money": {
    "amount": 20000,
    "currency": "MXN"
  }
}

响应

HTTP响应

字段	必填	类型	描述
Content-Type	是	String	HTTP响应内容类型规范固定值：application/json 指示JSON响应格式
X-TIMESTAMP	是	String	ISO 8601日期时间格式，带时区偏移格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-06:00

响应体参数

字段	必填	类型	描述
code	是	String	API响应状态码，指示操作结果格式：两位数字字符串成功："00"，错误：其他代码用于程序化响应处理
message	是	String	人类可读的响应状态描述格式：UTF-8编码字符串提供操作结果的详细信息根据请求语言本地化
orderNo	是	String	请求中提供的唯一交易标识符格式：字母数字字符串与请求中提供的orderNo相同用于交易跟踪和参考
merchant	是	Object	商户信息容器包含商户识别和业务详情参见商户模型
merchantId	是	String	平台分配的唯一商户标识符格式：字母数字字符串用于商户认证和交易路由
merchantName	否	String	商户业务名称或显示名称格式：UTF-8编码字符串用于商户识别和报告
subMerchantId	否	String	多级商户结构的子商户标识符格式：字母数字字符串用于子商户识别和报告
subMerchantName	否	String	子商户业务名称或显示名称格式：UTF-8编码字符串用于子商户识别和报告
money	是	Object	交易金额详情，包含货币规格包含确认的交易金额和货币参见货币模型
currency	是	String	ISO 4217货币代码规范固定值：MXN（墨西哥比索）确定支付处理规则和结算货币
amount	是	Number	最小货币单位的交易金额格式：整数值示例：20000表示MXN 20000 范围：100-999999999
disbursementTime	是	String	交易完成时间戳格式：yyyy-MM-ddTHH:mm:ss 示例：2020-12-17T10:55:00-06:00 用于交易时间和审计
channel	是	Object	支付渠道信息容器包含支付方式和处理详情参见渠道模型
tradeNo	否	String	系统跟踪的内部交易参考号格式：系统生成的字母数字字符串用于内部交易管理和支持
status	否	String	当前交易处理状态格式：预定义状态代码示例：PROCESSING, SUCCESS, FAILED, CANCELLED 指示交易的当前状态参见状态模型

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-06:00

{
  "channel": {
    "cashAccount": "123456789",
    "paymentMethod": "BANXICO"
  },
  "code": "00",
  "disbursementTime": "2024-01-13T13:31:11-06:00",
  "merchant": {
    "accountNo": "21220019202402271029",
    "merchantId": "20019",
    "merchantName": "20019"
  },
  "message": "成功",
  "money": {
    "amount": 20000,
    "currency": "MXN"
  },
  "orderNo": "20019ae81ede6-07bb-4c77-9937-658",
  "status": "处理中",
  "tradeNo": "122200192401131501111816"
}

通知

HTTP请求

字段	必填	类型	描述
Content-Type	是	String	HTTP请求内容类型规范固定值：application/json 指示JSON请求格式
X-TIMESTAMP	是	String	ISO 8601日期时间格式，带时区偏移格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-06:00
X-SIGNATURE	是	String	通知认证的数字签名参见回调签名验证

请求体参数

字段	必填	类型	描述
orderNo	是	String	商户交易标识符格式：字母数字字符串与原始请求中提供的orderNo相同用于交易识别和验证
tradeNo	是	String	系统跟踪的内部交易参考号格式：系统生成的字母数字字符串用于内部交易管理和支持
merchantId	是	String	平台分配的唯一商户标识符格式：字母数字字符串用于商户认证和交易路由
merchantName	是	String	商户业务名称或显示名称格式：UTF-8编码字符串用于商户识别和报告
subMerchantId	否	String	多级商户结构的子商户标识符格式：字母数字字符串用于子商户识别和报告
subMerchantName	否	String	子商户业务名称或显示名称格式：UTF-8编码字符串用于子商户识别和报告
paymentMethod	是	String	用于交易处理的支付方式格式：预定义支付方式代码示例：BANXICO, BANAMEX, BBVAMX, SANTANDER 指示实际使用的支付渠道
transactionTime	是	String	交易完成时间戳格式：yyyy-MM-ddTHH:mm:ss 示例：2020-12-17T10:55:00-06:00 用于交易时间和审计
status	是	String	最终交易处理状态格式：预定义状态代码示例：SUCCESS, FAILED, CANCELLED 指示交易的最终状态参见状态模型
money	是	Object	交易金额详情，包含货币规格包含确认的交易金额和货币参见货币模型
currency	是	String	ISO 4217货币代码规范固定值：MXN（墨西哥比索）确定支付处理规则和结算货币
amount	是	Number	最小货币单位的交易金额格式：整数值示例：20000表示MXN 20000 范围：100-999999999

重要响应

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

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 10000,
    "currency": "MXN"
  },
  "orderNo": "2000102900000000000001",
  "status": "SUCCESS",
  "tradeNo": "1022000109e998347483949",
  "transactionTime": "2024-07-03T17:34:07-06:00"
}

SUCCESS

API 付款交易

# 请求

# 请求路径：

# 请求头参数

# 请求体参数

# 请求体示例 – 付款请求：

# 响应

# HTTP响应

# 响应体参数

# 通知

# HTTP请求

# 请求体参数

# 返回

请求

请求路径：

请求头参数

请求体参数

请求体示例 – 付款请求：

响应

HTTP响应

响应体参数

通知

HTTP请求

请求体参数

返回