跳转至

代扣-解约接口

请求方式 body 编码 接口地址
POST application/json UTF-8 集测:https://mchapitest.shengpay.com/agreement/unSign
生产:https://mchapi.shengpay.com/agreement/unSign

请求参数

变量名 类型 必填 示例值 描述
mchId String Y 93751497 商户号
agreementNo String Y 外部协议号
unsignReason String Y 解约原因
nonceStr String Y 随机字符串
signType String Y RSA 签名类型
sign String Y 签名 (见签名介绍)

请求示例

1
2
3
4
5
6
7
8
{
    "mchId": "93751497",
    "nonceStr": "p3RNYdqF4dDrkFyAme3kZNfhFQxWT5Wq",
    "agreementNo": "1602813121825",
    "unsignReason": "到期",
    "sign": "cyOgsRehH3qeG6gt4WQr00/BkXgigzUZdDIqDKNJ7wghIQ/qrUJynqVUOlkCm1XPTo3gqrYt+l0EoWwLiu3Z102KoZPbYqpBkJN4U08H+fcwmSg76LDVq1Fu7zQSv02xaf849d0Pe5Tzh22JpM6LDEl78usF3O5oujPx1PgNzpTIXTNvvJOyvwkdvJcdBdY/jLBYefABqUFGA4J9QEIdr8bx7mBKCy9VTE+QBq3jW2l5wYpd3qrtwvS08D3y/TT4fdhR2SptHisvI1f8ISoiu89k6TSNtpzvI60XoEWz9qUNfxMhGbjUKFf0kSCjHAVog33XQwXeGTeSQItWKx4H7w==",
    "signType": "RSA"
}

响应参数

变量名 类型 必填 示例值 描述
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时使用)
status String Y UNSIGN 协议状态 :NOT_SIGN:未签约
SIGNING:签约中
UNKNOWN_SIGN:签约异常
SIGN:已签约
UNSIGN:已解约
nonceStr String Y 随机字符串
signType String Y RSA 签名类型
sign String Y 签名 (见签名介绍)

响应示例

1
2
3
4
5
6
7
8
{
    "returnCode": "SUCCESS",   
    "resultCode": "SUCCESS",
    "status": "UNSIGN",   
    "sign": "fv37v7C24HkGwu7EEPG54lH0oBuwj/dqHPav8Z0NegXeJ+9PRuZtxNAyipu7j0naxSGULaub3g9uqHCUe+X3FpGl2efQdqvBQhxHMJ8N1B0YP1VC8MK1BfUfFrUqh//D89LM8Zn20gXJaObbLaeVb012h6KPbjSXQpZm5uGQ/c4=",   
    "nonceStr": "ZchJlYzfTAismEusOCCPNERpcMIqXpPV",     
    "signType": "RSA"    
}
```

Back to top