Cancela uma solicitacao de assinatura, quando o provedor suporta.
curl --request POST \
--url https://api.example.com/api/services/app/Assinaturas/Cancelar \
--header 'Content-Type: application/json' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://api.example.com/api/services/app/Assinaturas/Cancelar"
payload = { "reason": "<string>" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://api.example.com/api/services/app/Assinaturas/Cancelar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/services/app/Assinaturas/Cancelar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/services/app/Assinaturas/Cancelar"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/services/app/Assinaturas/Cancelar")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/services/app/Assinaturas/Cancelar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"code": "<string>",
"provider": 123,
"documentName": "<string>",
"partnerReference": "<string>",
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"signers": [
{
"name": "<string>",
"registryCode": "<string>",
"email": "<string>",
"phone": "<string>",
"birthDate": "2023-11-07T05:31:56Z",
"signUrl": "<string>",
"status": 123,
"signedAt": "2023-11-07T05:31:56Z",
"biometry": {
"provider": "<string>",
"result": "<string>",
"reason": "<string>",
"band": "<string>",
"score": 123,
"checkedAt": "2023-11-07T05:31:56Z"
}
}
]
}Assinaturas
Cancelar
POST
/
api
/
services
/
app
/
Assinaturas
/
Cancelar
Cancela uma solicitacao de assinatura, quando o provedor suporta.
curl --request POST \
--url https://api.example.com/api/services/app/Assinaturas/Cancelar \
--header 'Content-Type: application/json' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://api.example.com/api/services/app/Assinaturas/Cancelar"
payload = { "reason": "<string>" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://api.example.com/api/services/app/Assinaturas/Cancelar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/services/app/Assinaturas/Cancelar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/services/app/Assinaturas/Cancelar"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/services/app/Assinaturas/Cancelar")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/services/app/Assinaturas/Cancelar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"code": "<string>",
"provider": 123,
"documentName": "<string>",
"partnerReference": "<string>",
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"signers": [
{
"name": "<string>",
"registryCode": "<string>",
"email": "<string>",
"phone": "<string>",
"birthDate": "2023-11-07T05:31:56Z",
"signUrl": "<string>",
"status": 123,
"signedAt": "2023-11-07T05:31:56Z",
"biometry": {
"provider": "<string>",
"result": "<string>",
"reason": "<string>",
"band": "<string>",
"score": 123,
"checkedAt": "2023-11-07T05:31:56Z"
}
}
]
}Cancela uma solicitação em aberto, quando o provedor suporta cancelamento.
O Unico ID não suporta cancelamento, e por isso a chamada é recusada com erro em vez de responder sucesso: uma resposta de sucesso diria que o processo foi cancelado enquanto ele segue válido e assinável. Nas solicitações do Unico ID, um processo não concluído expira por conta própria. No ZapSign o cancelamento funciona.
Autentique-se antes (Autenticação). Solicitação já
Assinado, Cancelado ou Expirado não pode ser cancelada.curl -X POST "https://gateway.hubcred.com.br/external/v1/api/services/app/Assinaturas/Cancelar?code=3f2b1c40-9a77-4c1e-9b3d-2f8a1d5e7c04" -H "Authorization: Bearer SEU_TOKEN"
Query Parameters
Code publico da solicitacao de assinatura.
Body
application/jsontext/json
Motivo do cancelamento, opcional.
Input opcional para cancelamento de assinatura.
Motivo do cancelamento. Opcional. Persistido para rastreabilidade; o ZapSign nao aceita motivo na API.
Maximum string length:
512Response
OK
Uma solicitacao de assinatura.
Code publico da solicitacao
Provedor: 1 Unico ID, 2 ZapSign
Nome do documento
Chave de idempotencia do parceiro
Situacao: 0 Pendente, 1 Enviado, 2 Assinado, 3 Recusado, 4 Cancelado, 5 Expirado, 6 Falhou
Momento da criacao
Momento da conclusao
Signatarios da solicitacao
Show child attributes
Show child attributes