跳转至

代扣-纯签约接口

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

请求参数

变量名 类型 必填 示例值 描述
mchId String Y 93751497 商户号
sdpAppId String Y SDP1023910231
agreementNo String Y 1602813121825 外部协议号
notifyUrl String Y http://www.baid.cm 异步通知地址
tradeType String Y alipay_period 交易类型:alipay_period 或者 wx_period
planId String Y sd2342 模板ID:当tradeType= wx_period和 upacp_dk 需要填写.参考
returnRedirect String Y Y 跳转地址:当tradeType= wx_period时，填写Y ，表示签约后离开微信APP；
当tradeType= alipay_period ，填写 签约后的跳转地址
signDisplayName String Y 连信读书 签约用户名称
subMerchantServiceName String Y 连信读书 子商户的服务名称
subMerchantServiceDescription String Y 免费快捷
signScene String Y 代扣场景：当tradeType= alipay_period 需要填写.参考
invokeScene String N 03 场景：01：app；03：小程序；04：公众号 ， 无感支付必填
merWxMpAppId String N 商户小程序id， 无感支付必填
merWxMpPath String N 商户小程序path
nonceStr String Y 随机字符串
signType String Y RSA 签名类型
sign String Y 签名 (见签名介绍)

请求示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
    "agreementNo": "VipCcOrda3369315",
    "mchId": "30195483",
    "notifyUrl": "http://vip.51y5.net/vipapi/jhcontractNotifyUrl",
    "planId": "138777",
    "returnRedirect": "Y",
    "sdpAppId": "476776922509684736",
    "signDisplayName": "136****3976",
    "tradeType": "wx_period",
    "nonceStr": "p3RNYdqF4dDrkFyAme3kZNfhFQxWT5Wq",
    "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时使用)
signParam String Y 签约信息
nonceStr String N 随机字符串
signType String N RSA 签名类型
sign String N 签名 (见签名介绍)

响应示例

1
2
3
4
5
{
    "returnCode": "SUCCESS", 
    "resultCode": "SUCCESS",
    "signParam": "3013d3012a72ea32e20e33b7ebaa5c0850eb28e1d85642d7ea6b1531688ee8ae1634718345uIlRrajX0cIpusA3SO1CfyJZLlAuh4WA"
}
Back to top