IOTPay 技术接入文档IOTPay 技术接入文档
  • 介绍
  • 签名
  • 统一下单
  • 商户扫码收款
  • 顾客扫描二维码
  • 微信JSAPI支付集成(mobile web)
  • 微信JSAPI支付集成(微信小程序)
  • 线上安全支付
  • 商户App集成IOTPay
  • 查询订单接口
  • 异步支付结果通知
  • 获取clientIP
  • 退款接口
  • 退款查询接口
  • POS 半集成
  • WordPress WooCommerce 插件
  • V3

    • 介绍
    • 重定向集成
    • 重定向集成(支持3DS与AVS)
    • 嵌入式集成
    • 直接支付
    • 查询卡信息
    • 使用令牌进行购买
    • 数字钱包支付
    • 撤销交易
    • 退款交易
    • 查询交易
    • 银联 ExpressPay API
  • V2

    • Credit Card API V2(不建议使用,请对接V3版本)
  • 介绍
  • 签约
  • 支付
  • 查询订单接口
  • 回调
  • English
  • 简体中文
  • 介绍
  • 签名
  • 统一下单
  • 商户扫码收款
  • 顾客扫描二维码
  • 微信JSAPI支付集成(mobile web)
  • 微信JSAPI支付集成(微信小程序)
  • 线上安全支付
  • 商户App集成IOTPay
  • 查询订单接口
  • 异步支付结果通知
  • 获取clientIP
  • 退款接口
  • 退款查询接口
  • POS 半集成
  • WordPress WooCommerce 插件
  • V3

    • 介绍
    • 重定向集成
    • 重定向集成(支持3DS与AVS)
    • 嵌入式集成
    • 直接支付
    • 查询卡信息
    • 使用令牌进行购买
    • 数字钱包支付
    • 撤销交易
    • 退款交易
    • 查询交易
    • 银联 ExpressPay API
  • V2

    • Credit Card API V2(不建议使用,请对接V3版本)
  • 介绍
  • 签约
  • 支付
  • 查询订单接口
  • 回调
  • English
  • 简体中文
  • 指南

    • 介绍
    • 签名
    • 统一下单
    • 商户扫码收款
    • 顾客扫描二维码
    • 微信JSAPI支付集成(mobile web)
    • 微信JSAPI支付集成(微信小程序)
    • 线上安全支付
    • 商户App集成IOTPay
    • 查询订单接口
    • 异步支付结果通知
    • 获取clientIP
    • 退款接口
    • 退款查询接口
    • POS 半集成
    • WordPress WooCommerce 插件
  • 信用卡

    • V3

      • 介绍
      • 重定向集成
      • 重定向集成(支持3DS与AVS)
      • 嵌入式集成
      • 直接支付
      • 查询卡信息
      • 使用令牌进行购买
      • 数字钱包支付
      • 撤销交易
      • 退款交易
      • 查询交易
      • 银联 ExpressPay API
    • Credit Card API V2(不建议使用,请对接V3版本)
  • 代扣

    • 介绍
    • 签约
    • 支付
    • 查询订单接口
    • 回调

支付

下单支付

端点

POST https://apiv3.iotpaycloud.com/contract/create_order

参数说明

字段名变量名必填类型示例值描述
商户IDmchId是String(30)10000701支付中心分配的商户号
商户订单号mchOrderNo是String(30)20160427210604000490商户生成的订单号,请保证唯一性
商户合约号mchContractId是String(128)2177aac8-1c3e-4291-97e0-f63f69b34cb6商户生成的合约号,请保证唯一性
渠道IDchannelId是String(24)WX_JSAPI,WX_APP, WX_MWEB见支付渠道参数
币种currency是String(3)CAD , CNY , USD三位货币代码,加币:CAD
支付金额amount是int100支付金额,单位分
客户端IPclientIp否String(32)
设备device否String(50)可选值 IOS,ANDROID终端设备号(门店号或收银设备ID),注意:PC网页或公众号内支付请传"WEB"
结果回调URLnotifyUrl是String(1000)https://xxx.com/notify.php支付结果回调URL,勿包含?
商品描述信息body是String(255)xxpay测试商品描述商品描述信息
附加参数extra是String(512)微信小程序,WX_APP, WX_MWEB需要
结束跳转URLreturnUrl否String(1000)WX_JSAPI, ALIPAY_PC, ALIPAY_WAP需要支付结束跳转URL,勿包含?
子账号jobNo是String(50)商户登录名
附言remarks否String(200)商户的附言
签名sign是String(32)C380BEC2BF3519F3AD6签名值,详见签名算法

WX_JSAPI区分微信小程序/H5/公众号

不传extra视为H5/公众号

附加参数extra说明

小程序支付(WX_JSAPI)

字段名变量名必填类型示例值描述
附加参数extra是JSON{"type":"minipay","appId":"xxxxxxxxx"}type,appId为必填。

微信App支付(WX_APP)

字段名变量名必填类型示例值描述
附加参数extra是JSON{"type":"apppay","appId":"xxxxxxxxx"}type,appId为必填。

返回结果

字段名变量名类型示例值描述
返回状态码retCodeString(16)SUCCESSSUCCESS/FAIL此字段是通信标识,非交易标识,交易是否成功需要查看resCode来判断
返回信息retMsgString(128)签名失败返回信息,如非空,为错误原因 签名失败 参数格式校验错误

以下字段在retCode为SUCCESS的时候有返回

字段名变量名必填类型示例值描述
业务结果resCode是String(16)SUCCESSSUCCESS/FAIL
错误代码errCode否String(32)SYSTEMERROR错误码
错误代码描述errCodeDes否String(128)系统错误结果信息描述

以下字段在retCode和resCode都为SUCCESS的时候有返回

字段名变量名类型示例值描述
支付订单号payOrderIdString(30)P20160427210604000490支付中心生成的订单号
商户IDmchIdString(30)20001222支付中心分配的商户号
商户订单号mchOrderNoString(30)20160427210604000490商户生成的订单号
渠道IDchannelIdString(24)WX_JSAPI见支付渠道参数
币种currencyString(3)CAD三位货币代码,加币:CAD
支付金额amountint100支付金额,单位分
状态statusint2支付状态, 2 or 3代表成功
客户端IPclientIpString(32)210.73.10.148客户端IP地址
设备deviceString(64)WEB终端设备号(门店号或收银设备ID),注意:PC网页或公众号内支付请传”WEB
商品主题subjectString(64)测试商品商品主题
商品描述信息bodyString(256)测试商品描述商品描述信息
渠道订单号channelOrderNoString(64)wx2016081611532915ae15b00b0167893571三方支付渠道订单号
扩展参数1param1String(64)支付中心回调时会原样返回(若为微信公众号内部支付,会被替换为"mchOrderId")
扩展参数2param2String(64)支付中心回调时会原样返回
支付成功时间paySuccTimelong精确到毫秒
通知类型backTypeint1通知类型,1-前台通知,2-后台通知
签名signString(32)C380BEC2BFD727A4B6845133519F3AD6签名值,详见签名算法
是否签约autodebitString(1)1是否签约,1-签约,0-非签约
商户合约号mchContractIdString(128)b53554e6-edd5-472b-b534-fe137fbbb382商户生成的合约号,请保证唯一性
Iotpay合约号iotpayContractIdString(128)CWJ20250819011704375030054146支付中心分配的合约号
货币金额currencyAmountString(10)77货币金额,单位分。只有currency于商户签约结算货币不同时返回

支付回调

回调方式

POST https://商户回调URL

以下字段在retCode和resCode都为SUCCESS的时候有返回

字段名变量名类型示例值描述
支付订单号payOrderIdString(30)P20160427210604000490支付中心生成的订单号
商户IDmchIdString(30)20001222支付中心分配的商户号
商户订单号mchOrderNoString(30)20160427210604000490商户生成的订单号
渠道IDchannelIdString(24)WX_JSAPI见支付渠道参数
币种currencyString(3)CAD三位货币代码,加币:CAD
支付金额amountint100支付金额,单位分
状态statusint2支付状态, 2 or 3代表成功
客户端IPclientIpString(32)210.73.10.148客户端IP地址
设备deviceString(64)WEB终端设备号(门店号或收银设备ID),注意:PC网页或公众号内支付请传”WEB
商品主题subjectString(64)测试商品商品主题
商品描述信息bodyString(256)测试商品描述商品描述信息
渠道订单号channelOrderNoString(64)wx2016081611532915ae15b00b0167893571三方支付渠道订单号
扩展参数1param1String(64)支付中心回调时会原样返回(若为微信公众号内部支付,会被替换为"mchOrderId")
扩展参数2param2String(64)支付中心回调时会原样返回
支付成功时间paySuccTimelong精确到毫秒
通知类型backTypeint1通知类型,1-前台通知,2-后台通知
签名signString(32)C380BEC2BFD727A4B6845133519F3AD6签名值,详见签名算法
是否签约autodebitString(1)1是否签约,1-签约,0-非签约
商户合约号mchContractIdString(128)b53554e6-edd5-472b-b534-fe137fbbb382商户生成的合约号,请保证唯一性
Iotpay合约号iotpayContractIdString(128)CWJ20250819011704375030054146支付中心分配的合约号
货币金额currencyAmountString(10)77货币金额,单位分。只有currency于商户签约结算货币不同时返回

返回结果

业务系统处理后同步返回给支付中心,返回字符串success则表示成功,返回非success则表示处理失败,支付中心会再次通知业务系统。*(通知次数最多4次)

主动轮询订单状态

对于没有后台的商家,例如从pos机软件来集成,无法提供notifyUrl来接收订单状态,可以采用主动轮询的方式来查询订单交易是否成功。
查看订单查询接口这里

双保险获取订单状态

强烈建议商家选择同时使用notifyUrl和轮询机制(30分钟)来确保能够获取订单交易状态

上次更新: 2025/8/25 19:28
Prev
签约
Next
查询订单接口