查询签约关系接口
请求方式 | body | 编码 | 接口地址 |
---|---|---|---|
POST | application/json | UTF-8 | 集测:https://mchapitest.shengpay.com/papay/contract/query 生产:https://mchapi.shengpay.com/papay/contract/query |
请求参数
变量名 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
appId | string | Y | 应用标识 | |
contractId | string | Y | 委托代扣协议ID | |
mchId | string | Y | 93747514 | 商户号 |
outContractCode | string | Y | 100000001 | 商户侧签约协议号 |
planId | int64 | Y | 100000 | 协议模板ID |
nonceStr | String | Y | nGBXiNhZjBaFrMGIJAKJQQpfNiSGVjzy | 随机字符串 |
signType | String | Y | RSA | 签名方式 |
sign | String | Y | 签名 (见签名介绍) |
1 2 3 4 5 6 7 |
|
响应参数
变量名 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
returnCode | String | Y | SUCCESS | 返回码(SUCCESS/FAIL) |
returnMsg | String | N | 返回消息(当returnCode为FAIL时使用) | |
resultCode | String | Y | SUCCESS | 业务结果(SUCCESS/FAIL) |
errorCode | String | N | 错误代码(当resultCode为FAIL时使用) | |
errorCodeDes | String | N | 错误描述(当resultCode为FAIL时使用) | |
contractDisplayAccount | string | Y | 签约用户的显示名称 | |
contractExpiredTime | string | N | 协议到期时间 | |
contractId | string | Y | 委托代扣协议ID | |
contractSignedTime | string | Y | 协议签署时间 | |
contractState | string | Y | Y("已签约"), N("已失效"), | UN_TERMINATION("未解约"), EXPIRE_TERMINATION("有效期过自动解约"), USER_TERMINATION("用户主动解约"), API_TERMINATION("商户API解约"), MERCHANT_TERMINATION("商户平台解约"), LOGOUT_TERMINATION("注销") |
contractTerminatedTime | string | 协议解约时间 | ||
contractTerminationMode | string | 协议解约方式 | ||
contractTerminationRemark | string | 解约备注 | ||
outContractCode | string | Y | 商户侧签约协议号 | |
planId | string | Y | 协议模板ID | |
nonceStr | String | Y | nGBXiNhZjBaFrMGIJAKJQQpfNiSGVjzy | 随机字符串 |
signType | String | Y | RSA | 签名方式 |
sign | String | Y | 签名 |
1 2 3 4 5 6 7 8 9 10 11 12 13 |
|