API 收款

请求

收款API使商户能够发起向客户收取付款的交易。
支持的支付方式包括：

QRPAY（快速响应支付）
银行转账
数字钱包
信用卡/借记卡
其他数字支付渠道

请求路径：

沙盒：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+07:00 注意：必须是当前服务器时间，误差在±5分钟内
X-SIGNATURE	M	String	请求认证的数字签名参见签名生成
X-PARTNER-ID	M	String	平台分配的唯一商户标识符格式：字母数字字符串用于商户认证和交易路由请输入merchantID

请求体参数

字段	必填	类型	描述
orderNo	M	String(32)	商户跟踪的唯一交易标识符格式：仅字母数字字符长度：6-32个字符在商户范围内必须是唯一的
purpose	M	String(64)	人类可读的交易描述格式：UTF-8编码字符串长度：1-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货币代码规范固定值：THB（泰铢）确定支付处理规则和结算货币
amount	M	Number	最小货币单位的交易金额格式：整数值示例：200表示THB 200.00 范围：100-999999999
payer	M	Object	客户支付信息容器用于支付验证和客户沟通
name	M	String	支付验证的客户全名格式：UTF-8编码字符串用于支付处理和交易记录
accountNo	M	String	支付处理的客户银行账户号格式：字母数字字符串用于银行转账支付验证
bankName	M	String	支付处理的客户银行名称格式：预定义银行代码示例：KBANK、BBL、SCB 指定paymentMethod时必需 ⚠️ BANK支付方式必需参见支付方式列表
paymentMethod	O	String	首选支付方式规范格式：预定义支付方式代码示例：`QRPAY`、`BANK` 参考：支付方式列表
expiryPeriod	O	Number	支付会话超时持续时间（秒）格式：整数值默认：3600秒（1小时）
redirectUrl	O	String(256)	支付后重定向目标URL 格式：有效的HTTP/HTTPS URL 最大长度：256个字符客户在支付完成后重定向到这里
callbackUrl	O	String(256)	Webhook通知端点URL 格式：有效的HTTP/HTTPS URL 最大长度：256个字符接收实时交易状态更新

重要说明

1. 支付方式选择： 如果未指定paymentMethod，将返回结账页面供客户选择其首选支付方式
2. 付款人信息要求： 指定paymentMethod时，您必须提供付款人姓名、账户号和银行名称以进行支付验证
3. 银行转账要求： 当paymentMethod设置为BANK时，付款人信息（姓名、accountNo、bankName）对银行转账处理是⚠️ 必需的
4. 银行名称参考： 有关支持的银行名称，请参见支付方式列表

请求体示例 – 交易请求：

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

{
    "payer": {
        "name": "test",
        "accountNo": "123456789009",
      "bankName": "KBANK"
    },
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "amount": 10000,
        "currency": "THB"
    },
  "orderNo": "20001e9d98b010db244c99d457c",
    "paymentMethod": "QRPAY",
    "purpose": "Java SDK交易目的",
    "redirectUrl": "https://docs.smilepayz.com/en/"
}

响应

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+07:00

响应体参数

字段	必填	类型	描述
code	M	String	API响应状态码，指示操作结果格式：两位数字字符串成功："00"，错误：其他代码用于程序化响应处理
message	M	String	人类可读的响应状态描述格式：UTF-8编码字符串提供操作结果的详细信息根据请求语言本地化
orderNo	M	String	用于参考的原始商户交易标识符格式：与请求orderNo相同用于交易跟踪和对账
tradeNo	O	String	系统跟踪的内部交易参考号格式：系统生成的字母数字字符串用于内部交易管理和支持
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货币代码规范固定值：THB（泰铢）确定支付处理规则和结算货币
amount	M	Number	最小货币单位的交易金额格式：整数值示例：200表示THB 200.00 范围：100-999999999
payAmount	O	Number	费用和调整后的实际支付金额格式：小数值示例：199.98表示THB 199.98 用于结算计算
transactionTime	M	String	ISO 8601日期时间格式（yyyy-MM-ddTHH:mm:ss±HH:mm）示例：2020-12-17T10:55:00+07:00 系统处理交易的时间戳
channel	M	Object	支付处理渠道详情和说明包含支付方式、URL和额外数据参见渠道模型
status	O	String	当前交易处理状态格式：预定义状态代码示例：PROCESSING、SUCCESS、FAILED 参见状态模型

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

{
    "channel": {
        "additionalInfo": {},
        "paymentMethod": "QRPAY",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=111200572411191251468673",
        "qrString": "00020101021229370016A0000006770101110113006680870163353037645406299.985802TH63048436"
    },
    "merchant": {
        "accountNo": "11120001202406101410",
        "merchantId": "20001",
        "merchantName": "test"
    },
    "money": {
        "amount": 300,
        "payAmount": 299.98,
        "currency": "THB"
    },
    "orderNo": "878d95fe75ef4c49b11d266afa8dd849",
    "status": "PROCESSING",
    "tradeNo": "111200012411191251468673",
    "transactionTime": "2024-11-19T12:51:47+07:00"
}

{
    "channel": {
        "additionalInfo": {},
        "paymentMethod": "BANK",
      "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1112001125042408363186433",
      "receiverBankName": "KBANK",
      "vaNumber": "2053617290"
    },
    "code": "00",
    "merchant": {
        "accountNo": "11120011202402290943",
        "merchantId": "20011",
        "merchantName": "bradytest123www"
    },
    "message": "成功",
    "money": {
        "amount": 100,
        "payAmount": 99.99,
        "currency": "THB"
    },
    "orderNo": "20011b5baff0ed8ac4f0c873920e",
    "status": "PROCESSING",
    "tradeNo": "1112001125042408363186433",
    "transactionTime": "2025-04-24T08:36:32+07: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+07:00
X-SIGNATURE	M	String	通知验证的数字签名格式：Base64编码签名用于验证通知真实性参见如何检查此值

通知体参数

字段	必填	类型	描述
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	用于交易处理的支付方式格式：预定义支付方式代码示例：QRPAY、BANK 指示实际使用的支付渠道
transactionTime	M	String	ISO 8601日期时间格式（yyyy-MM-ddTHH:mm:ss±HH:mm）支付提供商完成交易的时间戳
status	M	String	最终交易处理状态格式：预定义状态代码示例：SUCCESS、FAILED 指示交易的最终结果参见状态模型
money	M	Object	最终交易金额详情，带货币包含确认的支付金额和货币可能因费用或调整而与请求金额不同参见货币模型
currency	M	String	ISO 4217货币代码规范固定值：THB（泰铢）确定支付处理规则和结算货币
amount	M	Number	最小货币单位的交易金额格式：整数值示例：200表示THB 200.00 范围：100-999999999
payAmount	O	Number	费用和调整后的实际支付金额格式：小数值示例：199.98表示THB 199.98 用于结算计算
payer	M	Object	支付期间提供的客户信息格式：客户数据对象包含可用的付款人详情参见付款人模型

重要

通知请仅返回字符串SUCCESS

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 150,
    "currency": "THB"
  },
  "orderNo": "20001f7d65167e8b1419896f2dfb",
  "payer": {
    "name": "payerName",
    "accountNo": "*****25432"
  },
  "paymentMethod": "QRPAY",
  "status": "SUCCESS",
  "tradeNo": "111200012412151710505955",
  "transactionTime": "2024-12-15T17:10:51"
}

SUCCESS

API 收款

# 请求

# 请求路径：

# 请求头参数

# 请求体参数

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

# 响应

# HTTP响应

# 响应体参数

# 通知

# HTTP请求

# 通知体参数

# 返回

请求