查询用户协议信息

接口说明

接口名称 agreement_query
接口模式 直连
异步通知

应用场景

商户可通过调用此接口查询用户协议信息,以确认协议状态、协议是否存在。

接口参数

  • 请求:
说明 字段 类型 条件 示例值 备注
代理商商户号 agentMerId S(16) 100003789 宝付支付分配的商户号
代理商终端号 agentTerId S(16) 213003567 宝付支付分配的终端号
交易商户号 merId S(16) 102002369 宝付支付分配的商户号
交易终端号 terId S(16) 100003123 宝付支付分配的终端号
商户自定义用户协议号 outAgreementNo S(32) 20250306115103172299 商户自定义用户协议号、用户标识二选一。若均传值,都需均匹配
用户标识 openId S(128) 2088102146225135 买家支付宝用户id (2088开头的user_id)
  • 返回:
说明 字段 类型 条件 示例值 备注
代理商商户号 agentMerId S(16) 100003789 宝付支付分配的商户号
代理商终端号 agentTerId S(16) 213003567 宝付支付分配的终端号
交易商户号 merId S(16) 102002369 宝付支付分配的商户号
交易终端号 terId S(16) 100003123 宝付支付分配的终端号
用户协议列表 agreementList C 最多10条(按创建时间降序返回),JSON 数组
详见:【协议信息】
业务结果 resultCode S(16) SUCCESS 业务处理结果
错误代码 errCode S(32) 当业务结果FAIL时,返回错误代码
错误描述 errMsg S(128) 当业务结果为FAIL时,返回错误描述

协议信息

说明 字段 类型 条件 示例值 备注
商户自定义用户协议号 outAgreementNo S(32) 商户生成的协议号
协议状态 agreementState S(32) INVALID:无效;VALID:有效
开通时间 createTime S(14) 20250301103059 格式:yyyyMMddHHmmss
作者:admin  创建时间:2025-03-21 18:44
最后编辑:lilizhi  更新时间:2025-06-17 14:16