跳至主要內容

代收订单 · 泰国

TOPPAY Team大约 4 分钟

请求

代收 API 用于向客户发起代收交易。本页为 泰国(国家码 th)的代收能力说明。

请求路径

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

环境地址
沙箱https://openapi.toppayment.com/sandbox/th/pay/prePay
生产https://openapi.toppayment.com/th/pay/prePay

method(泰国代收方式编码)见 地区支付说明 — 泰国

请求头

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

请求体

字段必填类型描述
mchNoMString(32)商户编号
平台分配的唯一商户标识符
用于商户认证和交易路由
orderNumMString(64)商户订单号
唯一交易标识符
格式:字母数字字符串
用于交易跟踪和参考
amountMNumber(32,8)交易金额
格式:数值类型
示例:100
productDetailMString (100)产品详情
交易目的或描述
格式:UTF-8编码字符串
methodMString (16)支付方式(泰国)
支持 qrPayBankTransfer,完整列表见 地区支付说明 — 泰国
payerBankCodeMString (32)付款银行编码
payerAccountNoMString (64)付款账号
timestampMString(13)时间戳
请求时间戳(毫秒级)
示例:1749451858772
customerNameMString (64)客户姓名
付款人姓名
格式:UTF-8编码字符串
customerEmailMString (64)客户邮箱
付款人邮箱地址
格式:有效的邮箱格式
customerPhoneMString (32)客户电话
付款人电话号码
格式:有效的电话号码
expiryPeriodONumber(1-9999)过期时间
交易过期时间(分钟)
示例:1440(24小时)
downNotifyUrlMString(255)异步通知地址
交易状态更新的Webhook通知URL
格式:有效的HTTP/HTTPS URL
redirectUrlOString(512)重定向地址
支付完成后客户重定向URL
格式:有效的HTTP/HTTPS URL
signMString签名
请求认证的数字签名
参见签名生成

请求示例

{
  "mchNo": "{{mchNo}}",
  "orderNum": "TH1232451",
  "amount": 100,
  "productDetail": "测试",
  "method": "qrPay",
  "payerBankCode": "KBANK",
  "payerAccountNo": "0817773255",
  "timestamp": "1749451858772",
  "customerName": "AMY",
  "customerEmail": "[email protected]",
  "customerPhone": "0817773255",
  "expiryPeriod": 1440,
  "downNotifyUrl": "https://123.com",
  "redirectUrl": "http://hxxyhyo.mr/gchmnzv",
  "sign": "按签名规则生成后替换"
}

响应

HTTP响应

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

响应字段

字段必填类型描述
successMBoolean请求是否成功
true:成功,false:失败
codeMString响应状态码
9999:成功
其他:失败
msgOString响应消息
可读的响应状态描述
成功时为null
timeStampMNumber响应时间戳
服务器响应时间(毫秒级)
dataMObject响应数据对象
包含交易详细信息
orderNumMString商户订单号
platOrderNumMString平台订单号
amountMNumber交易金额
feeMNumber手续费
methodMString支付方式(泰国)
编码含义见 地区支付说明 — 泰国
productDetailMString产品详情
customerNameMString客户姓名
customerEmailMString客户邮箱
customerPhoneMString客户电话
validTimeMNumber有效期时间戳
cashierUrlMString收银台URL(收银台模式)
payDataMString支付数据
payDataTypeMString支付数据类型(示例:QR_CODEVA

响应示例

{
  "success": true,
  "code": "9999",
  "msg": null,
  "timeStamp": 1767840272829,
  "data": {
    "orderNum": "TH1232451",
    "platOrderNum": "PRE2009093829059153920",
    "amount": 100,
    "fee": 2.00,
    "method": "qrPay",
    "productDetail": "测试",
    "customerName": "AMY",
    "customerEmail": "[email protected]",
    "customerPhone": "0817773255",
    "validTime": 1767926672819,
    "cashierUrl": "https://example.cashier/pay",
    "payData": "https://example.cashier/pay",
    "payDataType": "QR_CODE"
  }
}

通知

HTTP请求

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

通知体

字段必填类型描述
platOrderNumMString平台订单号
versionMString版本号(示例:v1)
orderNumMString商户订单号
amountMNumber交易金额
feeMNumber手续费
customerNameMString客户姓名
customerEmailMString客户邮箱
customerPhoneMString客户电话
statusMString交易状态
取值见 交易状态码
signMString回调签名

返回

SUCCESS

通知示例

{
  "platOrderNum": "PRE2009165141186183168",
  "version": "v1",
  "orderNum": "TH12324521",
  "amount": 100,
  "fee": 2,
  "customerName": "AMY",
  "customerEmail": "[email protected]",
  "customerPhone": "0817773255",
  "status": "SUCCESS",
  "sign": "示例签名"
}