API 收款交易

请求

收款API使商户能够发起向客户收取付款的交易。此API支持各种支付方式，用于菲律宾市场的安全和高效资金收集。

请求路径：

沙盒：https://sandbox-gateway.smilepayz.com/v2.0/transaction/pay-in
生产：https://gateway.smilepayz.com/v2.0/transaction/pay-in

请求头参数

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

请求体参数

字段	必填	类型	描述
orderNo	M	String(32)	唯一交易标识符格式：字母数字字符串（仅数字和字母）长度：6-32个字符用于交易跟踪和参考
purpose	M	String(64)	交易目的或描述格式：UTF-8编码字符串最大长度：64个字符用于交易识别和报告
merchant	M	Object	商户信息容器包含商户识别和业务详情参见商户模型
merchantId	M	String	平台分配的唯一商户标识符格式：字母数字字符串用于商户认证和交易路由
merchantName	O	String	商户业务名称或显示名称格式：UTF-8编码字符串用于商户识别和报告
subMerchantId	O	String	多级商户结构的子商户标识符格式：字母数字字符串用于子商户识别和报告
subMerchantName	O	String	子商户业务名称或显示名称格式：UTF-8编码字符串用于子商户识别和报告
money	M	Object	交易金额详情，带货币规格包含交易金额和货币信息参见货币模型
currency	M	String	ISO 4217货币代码规范固定值：PHP（菲律宾比索）确定支付处理规则和结算货币
amount	M	Number	最小货币单位的交易金额格式：整数值示例：20000表示PHP 20000 范围：100-999999999
paymentMethod	O	String	用于交易处理的支付方式格式：预定义支付方式代码示例：GCASH、PAY_MAYA、BPI_BANK 指示实际使用的支付渠道参见支付方式列表
expiryPeriod	O	Number	交易过期时间（秒）格式：整数值默认：3600（1小时）最大：86400（24小时）用于设置交易有效期
redirectUrl	O	String(256)	支付完成后客户重定向URL 格式：有效的HTTP/HTTPS URL 最大长度：256个字符用于支付处理后重定向客户
callbackUrl	O	String(256)	交易状态更新的Webhook通知URL 格式：有效的HTTP/HTTPS URL 最大长度：256个字符用于实时交易状态通知

请求体示例 – 交易请求：

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

{
    "merchant": {
        "merchantId": "20011"
    },
    "money": {
        "amount": 20000,
        "currency": "PHP"
    },
    "orderNo": "200110edbb466abb04682968b40",
    "paymentMethod": "GCASH",
    "purpose": "在线购买支付",
    "redirectUrl": "https://www.example.com/success"
}

响应

HTTP响应

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

响应体参数

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

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

{
    "channel": {
        "additionalInfo": {
            "paymentUrl": "https://wpay.gpayment.net/api/payment_direct/redirect/ptpayd14302662"
        },
        "paymentMethod": "GCASH",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1812003025061909313195096"
    },
    "code": "00",
    "merchant": {
        "accountNo": "11820011202403071031",
        "merchantId": "20011",
        "merchantName": "bradytest123www"
    },
    "message": "成功",
    "money": {
        "amount": 20000,
        "currency": "PHP"
    },
    "orderNo": "20011563d9094aa7d4d9e9b933bb",
    "status": "PROCESSING",
    "tradeNo": "1812001125042115424463245",
    "transactionTime": "2025-06-19T10:31:33+08:00"
}

通知

HTTP请求

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

通知体参数

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

重要响应

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

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 100000,
    "currency": "PHP"
  },
  "orderNo": "2000102900000000000001",
  "status": "SUCCESS",
  "tradeNo": "181200012410241325417215",
  "transactionTime": "2020-12-17T10:55:00+08:00"
}

SUCCESS

API 收款交易

# 请求

# 请求路径：

# 请求头参数

# 请求体参数

# 请求体示例 – 交易请求：

# 响应

# HTTP响应

# 响应体参数

# 通知

# HTTP请求

# 通知体参数

# 返回

请求

请求路径：

请求头参数

请求体参数

请求体示例 – 交易请求：

响应

HTTP响应

响应体参数

通知

HTTP请求

通知体参数

返回