1. 接入指引
付临门开放平台
  • 文档说明
    • 阅读对象
    • 版本历史
  • 接入指引
    • 对接流程
    • 常见问题
    • 接口格式
    • 签名验签说明
    • DEMO示例
    • 数字字典
      • imgType字典
      • changeType字典
      • auditStatus字典
      • licValidityType 字典
      • terminalCompany字典
      • termMode字典
      • deviceType字典
      • ntltyCode字典
      • idTp字典
  • 商户管理
    • 业务指引
    • 商户进件
      • 图片上传
      • 商户进件
      • 进件状态查询
      • 进件回调通知
      • 电子签约查询
      • 微信支付宝拆分结果查询
      • 微信支付宝认证结果查询
      • 银联入网结果查询
      • 重发电子签约短信
      • 签约回调通知
      • 商户限额查询
      • 商户查询
    • 终端管理
      • 设备绑定
      • 设备解绑
      • 设备查询
      • 终端信息变更
    • 微信支付宝配置
      • 微信APPID配置
      • 微信授权目录配置
      • 微信配置参数查询
    • 商户信息变更
      • 基本信息变更
      • 结算信息变更
      • 费率变更
      • 结算方式变更
      • 商户变更进度查询
      • 商户变更回调通知
      • 商户开通/关闭定时结算
      • 商户限额变更申请
      • 商户主体变更申请
    • 入网辅助类
      • MCC查询
      • 获取银联开户省
      • 获取银联开户市
      • 获取银联开户地区
      • 获取银联总行行号
      • 获取银联支行行号
      • 设备解绑通知
      • 商户状态变更回调通知
  • 支付交易
    • 业务指引
    • 扫码支付
      • JSAPI支付
      • 付款码支付
      • 动态支付
      • 交易查询
      • 交易退货
      • 交易撤销
      • 退款查询
      • 交易关闭
      • 授权码获取微信 openid
    • 回调通知
      • 支付结果异步通知
      • 退款结果异步通知
    • 扫码担保
      • 扫码担保受理
      • 扫码担保完成
      • 扫码担保撤销
    • 附录
      • 支付状态说明
      • 支付方式说明
      • 单品优惠 - 微信渠道
      • 单品优惠 - 支付宝渠道
      • 单品优惠 - 云闪付渠道
  • 增值业务
    • 营销活动
      • 业务指引
      • 营销结果通知
      • 营销账户余额查询
      • 商户补贴额度查询
    • 出金业务
      • 资金划拨记录查询
      • 商户余额查询
    • 特色结算业务
      • 特色结算业务开通
      • 特色结算业务开通记录状态查询
      • 提交快速结算订单
      • 查询快速结算订单结果
      • 快速结算订单回调
    • 分账类
      • 分账绑定关系查询
      • 订单分账申请
      • 分账结果查询
      • 分账回退
      • 分账回退查询
      • 分账退款查询
      • 分账异步通知
      • 余额分账申请
      • 分账完结申请
    • 分账服务
      • 业务指引
      • 订单分账
      • 余额分账
  • 对账文件
    • 文件说明
    • 开通流程
  • POS终端对接
    • 接入流程
  • 附录
    • 应答码
    • MCC列表
    • 银行列表
  • 数据模型
    • RequestDatagramPaymentOrder
    • WechatGoodsItem
    • ZD标准交易对账单(csv)
    • RequestDatagramJsapi
    • WechatGoodsDiscountDetail
    • YX机构营销对账单(csv)
    • RequestDatagramAuthOrder
    • 交易类型枚举
    • RequestDatagramAuthComplete
    • AlipayGoodsItem
    • 营销类型枚举
    • RequestDatagramDynamic
    • 卡类型枚举
    • RequestDatagramRefund
    • UnionpayOrderInfo
    • 结算周期枚举
    • RequestDatagramAuthOrderCancel
    • UnionpayGoodsInfo
    • 支付方式枚举
    • RequestDatagramCancel
    • RequestDatagramClose
    • RequestDatagramQuery
    • GoodsDiscountInfo
    • RequestDatagramGetOpenId
    • CommonRequest
    • RequestDatagramRefundQuery
    • CommonResponse
    • PaymentOrderRequest
    • MarketingInfoReq
    • JsapiPaymentOrderRequest
    • MarketingInfoResp
    • AuthOrderRequest
    • PayOrderARequest
    • AuthCompleteOrderRequest
    • PayOrderAResponseData
    • DynamicPaymentRequest
    • PayOrderBRequest
    • TradeRefundRequest
    • PayOrderBResponseData
    • AuthOrderCancelRequest
    • DynamicPayRequest
    • TradeCancelRequest
    • DynamicPayResponseData
    • TradeCloseRequest
    • OrderQueryRequest
    • TradeQueryRequest
    • OrderQueryResponseData
    • GetOpenIdRequest
    • OrderCancelRequest
    • RefundQueryRequest
    • RefundOrderRequest
    • ResponseDatagram
    • PaymentResponse
    • RefundResponseData
    • PaymentDynamicResponse
    • OrderCloseRequest
    • RefundResponse
    • OrderCloseResponseData
    • OrderCloseResponse
    • OpenIdRequest
    • OrderQueryResponse
    • OpenIdResponseData
    • GetOpenIdResponse
    • MarketingInfoRes
    • AuthOrderResponseData
    • ResponseDatagramPaymentOrder
    • AuthCompleteRequest
    • ResponseDatagramJsapi
    • AuthCancelRequest
    • ResponseDatagramAuthOrder
    • NotifyPayData
    • ResponseDatagramAuthComplete
    • NotifyRefundData
    • ResponseDatagramDynamic
    • NotifyResponse
    • ResponseDatagramRefund
    • MarketingNotifyData
    • ResponseDatagramRefundAuthCancel
    • PayOrderARequestWrap
    • ResponseDatagramCancel
    • PayOrderAResponseWrap
    • ResponseDatagramClose
    • PayOrderBRequestWrap
    • ResponseDatagramQuery
    • PayOrderBResponseWrap
    • ResponseDatagramGetOpenId
    • DynamicPayRequestWrap
    • ResponseDatagramRefundQuery
    • DynamicPayResponseWrap
    • PayNotifyRequest
    • OrderQueryRequestWrap
    • RefundNotifyRequest
    • OrderQueryResponseWrap
    • NotifyAck
    • OrderCancelRequestWrap
    • RefundOrderRequestWrap
    • WechatGoodsDetailItem
    • WechatGoodsDiscountInfo
    • RefundQueryRequestWrap
    • RefundResponseWrap
    • AlipayGoodsDetailItem
    • AlipayGoodsDiscountInfo
    • OrderCloseRequestWrap
    • OrderCloseResponseWrap
    • UnionpayGoodsInfoItem
    • UnionpayAcqAddnData
    • OpenIdRequestWrap
    • UnionpayGoodsDiscountInfo
    • OpenIdResponseWrap
    • AuthOrderRequestWrap
    • PaymentOrderResponse
    • AuthOrderResponseWrap
    • JsapiPaymentResponse
    • AuthCompleteRequestWrap
    • AuthCompleteResponse
    • AuthCancelRequestWrap
    • PayOrderRequestUnion
  1. 接入指引

接口格式

对于请求报文中的timestamp字段,请勿小于或大于当前时间15分钟
对于请求报文中的serialNo字段,请保证唯一
针对图片上传接口需要特殊处理,详见图片上传

1. 协议规则#

协议版本:采用 HTTP/1.1
传输协议:采用 HTTPS
请求方式:统一使用 POST
数据格式:JSON
字符编码:统一使用 UTF-8

2. 通用请求报文格式#

2.1请求示例#

{
  "serialNo": "87912377819284756172",
  "version": "1.0",
  "timestamp": "1792573646112",
  "data": "{\"name\":\"test\"}",
  "signature": "FMWYWCotvTomwCKMj85h55wHyuFQv95HE/mjGNkiyouMcjiPrOhsBaeFSISDRlcVKrEQdEBn6KbNqj1syA/CNtk20QY8V58bpXzU1f71LANmPwk4YFpXNdM8TcyBLqyMTG0mxKL2JAv6sO8G9xmty0cudf3tqMKIDxYAtyG6pqUtpVrU4LDR6nkiv7KlWYkrdApvcSmj6ih6Cth0/BK3uBNQwdKX0fuMeN5l4sgAWnhAWkNn/wWls+RIucU4eBEakWz9OnhVXlt9YTOi/UpTUb0mnlx4FyQ6AXyR4mr0Sp9UaJWpah0xF4RNaMg41Apn0VkK0+RGypBaMJWQ7Pyu/A==",
  "appId": "888888"
}

2.2请求字段说明#

字段名类型必填说明
serialNoString(32)Y请求流水号,保证唯一
versionString(10)N版本号,默认1.0
timestampStringY当前请求毫秒级时间戳
dataStringY业务数据(JSON字符串)
signatureStringY签名值
appIdString(6)Y服务商号

3.通用响应体格式#

3.1响应示例#

{
  "data": "{\"name\":\"test\"}",
  "signature": "PVRaWsysbw2ydBlAjcgFZBy3TcfDT85IYjBkTOhkosdJSQm9V63Wwikd2W9Hxck59udk4y6qMRADFPrm1qnU97+RZ/vDY2r1IkSMJFp/lWM6oq387hZvsf7UY9hNHZLk2MNy3ald1GkI3BCf+rEtYNrrnjp3S8uAdj+gXgkd3ke6XADN6p9LHu5+TGAMnIEV0iEAjEq6MC8y0+Yt5KH+ugh6RITchzAbyVUt7MfKG4ZuDMQ8DIALXVIWvsmL6YUtlbpce/2JFoC8Tj6K0u6taRMmzcg3Cg9k3apJ48ad9ZfVRF2VSXr5kBJyiS7xKXTED4O8k0L7+vOHxMG6odwNAg==",
  "code": "0000",
  "msg": "调用成功",
  "traceId": "c3999a4d4dd8489c904a41b04d55ddc2"
}

3.2响应字段说明#

字段名类型必填说明
dataStringN业务数据(JSON字符串)
signatureStringY签名值
codeStringY响应码
msgStringN响应描述
traceIdStringY链路id

4.请求头#

4.1请求头示例#

Content-Type: application/json
Sign-Algorithm: RSA

4.2请求头字段说明#

字段名类型必填说明
Sign-AlgorithmStringN可选值为RSA

5.统一返回码#

返回码返回码释义说明
0000调用成功接口调用成功,业务处理成功
9999系统错误接口调用成功,业务处理失败
OPG105000服务器开小差了,请稍后再试系统内部错误
OPG104000请求参数错误缺少必填参数
OPG104030无权限访问机构不存在
OPG104031当前IP未配置白名单,禁止访问请先配置ip白名单
OPG104032验签失败验签失败
OPG104033当前机构已被禁用,请联系对接人员机构已被禁用
OPG104001请求时间戳格式错误输入正确格式的时间戳
OPG104002请求时间戳超出允许范围请求时间戳不允许跨跃当前时间15分钟
OPG104003未找到数据签名服务不受支持的签名算法

6.回调通用请求体格式#

6.1请求示例#

{
  "data": "{\"name\":\"test\"}",
  "signature": "PVRaWsysbw2ydBlAjcgFZBy3TcfDT85IYjBkTOhkosdJSQm9V63Wwikd2W9Hxck59udk4y6qMRADFPrm1qnU97+RZ/vDY2r1IkSMJFp/lWM6oq387hZvsf7UY9hNHZLk2MNy3ald1GkI3BCf+rEtYNrrnjp3S8uAdj+gXgkd3ke6XADN6p9LHu5+TGAMnIEV0iEAjEq6MC8y0+Yt5KH+ugh6RITchzAbyVUt7MfKG4ZuDMQ8DIALXVIWvsmL6YUtlbpce/2JFoC8Tj6K0u6taRMmzcg3Cg9k3apJ48ad9ZfVRF2VSXr5kBJyiS7xKXTED4O8k0L7+vOHxMG6odwNAg==",
  "code": "0000",
  "msg": "调用成功"
}

6.2请求字段说明#

字段名类型必填说明
dataStringN业务数据(JSON字符串)
signatureStringY签名值
codeStringY响应码
msgStringN响应描述
修改于 2026-10-27 07:38:46
上一页
常见问题
下一页
签名验签说明
Built with