通过页面发起合同解约

更新时间:2024-08-21 18:07:49

接口描述

原流程中的合同文件在签署方均已完成签署的前提下,其中的任一签署方或原流程的发起方可以申请发起合同解约,系统提供发起合同解约的页面,通过页面发起解约成功后,签署方收到解约协议签署链接,签署方之间重新签订一份 “解约协议”,“解约协议”签署成功后,原签署文件将失效。

注意事项:

  • 仅限已完成状态流程中的签署方或发起方来发起合同解约;
  • 单方签署的流程不支持发起解约(流程中必须包含2个及以上的签署方)。

接口地址&请求方法

接口地址:https://{host}/v3/sign-flow/{signFlowId}/rescission-url

请求方法:POST

请求头格式

具体请求头参数,请查看公共请求头格式。

请求参数

展开全部参数参数名称

参数类型

必选

参数位置

参数说明(请左右滑动查看完整描述)

signFlowId

string

是

path

已完成状态的签署流程ID

rescissionInitiator

object

是

body

合同解约发起方信息

  • 仅原流程中的签署方或发起方可以发起解约;
  • 发起方需先经过 用户授权(代个人/企业用户发起合同签署权限);
  • psnInitiator与orgInitiator二选一传入。

psnInitiator

object

否

body

解约发起人信息

psnId

string

否

body

个人账号ID

orgInitiator

object

否

body

解约发起机构信息

orgId

string

否

body

机构账号ID

transactor

object

否

body

机构经办人信息

psnId

string

否

body

经办人账号ID

signFlowConfig

object

否

body

解约流程配置项

chargeConfig

object

否

body

解约流程的计费配置项

chargeMode

int32

否

body

计费模式,默认0,(若传1,需获取发起方的套餐订单使用授权,且发起方必须是机构)

0 - 接口集成方付费(指应用ID所属企业)

1 - 解约发起方企业付费(发起方见上文rescissionInitiator参数)

orderType

string

否

body

订单套餐类型,默认为普通订单套餐

可选值:DISTRIBUTION - 生态伙伴订单套餐

【注】只有已登记成为系统生态伙伴之后,才允许传值DISTRIBUTION

redirectConfig

object

否

body

重定向配置项

redirectUrl

string

否

body

解约协议签署完成后跳转页面

redirectDelayTime

int32

否

body

操作完成后页面重定向跳转延迟时间,单位为秒,默认3秒。

0 - 不展示签署完成结果页,签署完成直接跳转重定向地址。

X - 展示签署完成结果页,倒计时X秒后,自动跳转重定向地址

注:当redirectUrl不传的情况下,该字段无需传入,默认签署完成结果页不跳转。

noticeConfig

object

否

body

解约协议通知配置项(通知原流程中的签署方、抄送方)

noticeTypes

string

否

body

通知类型,默认值为""空字符串

"" - 不进行任何通知

1 - 短信通知

2 - 邮件通知

notifyUrl

string

否

body

接收合同解约回调通知的Web地址

详见【签署回调通知接收说明】

clientType

string

否

body

指定客户端类型,默认值:ALL

H5 - 移动端适配

PC - PC端适配

ALL - 自动适配移动端或PC端(默认值)

【注】参数值均为大写的英文

响应参数

展开全部参数参数名称

参数类型

必选

参数说明

code

int32

是

业务码,0表示成功,非0表示异常。

message

string

否

业务信息

请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。

data

object

否

业务数据

rescissionUrl

string

否

发起合同解约页面长链地址(永久有效)

rescissionShortUrl

string

否

发起合同解约页面短链地址(有效期180天)

请求示例

{
    "rescissionInitiator":{
        "orgInitiator":{
            "orgId":"0c5bd49248***5648bfbf",
            "transactor":{
                "psnId":"c7e002947***310541e7"
            }
        }
    },
    "signFlowConfig":{
        "notifyUrl":"https://xx.xx.xx/callback"
    }
}

响应示例

{
    "code":0,
    "message":"成功",
    "data":{
        "rescissionUrl":"https://bestcert.net/start/rescind?context=xx&flowId=xx&chargeMode=1¬iceTypes=1,2&initiatorAccountId=xx&initiatorSubjectAccountId=xx&initiatorIdentityAccountType=2&tsign_source_type=SIGN_LINK_WUKONG&tsign_source_detail=16R2mv%xx%x%x%xx%x%xx",
        "rescissionShortUrl":"https://bestcert.net/g1sX***R4wZ"
    }
}

错误码

点击查看错误码