Voltar ao site
Contratos

Cancelar contrato

POST/v1/contracts/{id}/cancel

Cancela um contrato ainda não encerrado (canceled): o documento sai do provedor e os links de assinatura param de funcionar.

  • Contrato signed, refused, expired ou canceled → 409 CONTRACT.NOT_EDITABLE.
  • Repetir com a mesma chave devolve o contrato cancelado.
  • Sem contracts:contracts:write → 403 AUTH.ENTITLEMENT_MISSING.

Authorization

kodanoOAuth contracts:contracts:write
headerAuthorizationBearer <token>

Token obtido no Zitadel do ambiente (POST /oauth/v2/token), fora do host da API, e enviado em Authorization: Bearer <access_token>.

  • Sandbox: https://kodano-uat-p55zt6.us1.zitadel.cloud/oauth/v2/token
  • Produção: https://kodano-prod-qe8hbt.us1.zitadel.cloud/oauth/v2/token

Use sempre o tokenUrl devolvido na emissão da credencial. Duas variantes: private_key_jwt (preferida; grant urn:ietf:params:oauth:grant-type:jwt-bearer com assertion RS256 assinada pela chave da credencial, iss = sub = userId, aud = authority do Zitadel, kid = keyId) e client_secret (grant client_credentials). O OpenAPI só modela a segunda.

O parâmetro scope do token é OIDC, não os escopos da API: openid urn:zitadel:iam:org:project:id:<projectId da API>:aud urn:zitadel:iam:user:resourceowner. Sem o :aud a API responde 401 AUTH.TOKEN_INVALID; sem resourceowner, 403 AUTH.TENANT_MISMATCH.

Os 28 escopos abaixo são os entitlements concedidos à credencial pelos produtos de integração (produto:recurso:ação; write não implica read), avaliados a cada requisição; não são pedidos no token. O tenant vem da organização do token; o merchant, de X-Merchant-Id. Revogar a credencial nega os tokens já emitidos em até 60 s.

Scope: contracts:contracts:write

Path Parameters

id*string

Id do contrato, ctr_ + 32 hexadecimais. Inexistente, malformado ou de outro merchant → 404 CONTRACT.NOT_FOUND.

Header Parameters

X-Merchant-Id*string

Merchant da operação (mrc_ + Guid sem hífens, minúsculo). Obrigatório com credencial de organização (ausente → 400 MERCHANT.HEADER_REQUIRED); com credencial de merchant é opcional (ausente = o próprio merchant). Malformado, repetido, inexistente ou de outro tenant → 403 MERCHANT.FORBIDDEN (nunca 404). Vazio = ausente.

Match^mrc_[0-9a-f]{32}$
Idempotency-Key*string

UUID, retido por 24 h a partir da primeira chamada. Escopo: (tenant, merchant, rota-template, chave). Mesma chave e mesmo corpo → resposta original (2xx ou 4xx) com X-Idempotent-Replay: true; corpo ou path concreto diferente → 409 IDEMPOTENCY.CONFLICT; em execução ou desfecho desconhecido → 409 IDEMPOTENCY.IN_PROGRESS com resourceId e Retry-After: 2. Ausente ou não-UUID → 422 IDEMPOTENCY.KEY_REQUIRED.

Formatuuid
X-Correlation-Id?string

Opcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.

Match^[A-Za-z0-9._-]{1,64}$

Request Body

application/json
  1. body
reason?string
Lengthlength <= 500

Response Body

Contrato cancelado.

application/json
  1. response
id*string

ctr_ + 32 hexadecimais.

status*ContractStatus

draft só existe durante a emissão; signed, refused, expired e canceled são finais.

Value in"draft""pending_signature""viewed""partially_signed""signed""refused""expired""canceled"
name*string
description*string|null
contractTemplateId*string|null
contractFileId*string|null
signersExpected*integer
signersSigned*integer
requiredSignersExpected*integer
requiredSignersSigned*integer
allowRefusal*boolean
advancedAuth*boolean
refusedReason*string|null
expiresAt*|
Formatdate-time
effectiveAt*|
Formatdate-time
signedAt*|
Formatdate-time
canceledAt*|
Formatdate-time
hasSignedFile*boolean
tagValues*array<>
signers*array<>
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
Example Request
curl -X POST 'https://api.sandbox.kodano.com.br/v1/contracts/ctr_0192f3b0c4d17e8a9b2f5c6d7e8f9a0b/cancel' \  -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \  -H 'Idempotency-Key: 4b2e8c1a-9d7f-4e3b-a6c5-0f1e2d3c4b5a' \  -H 'X-Correlation-Id: erp-7f3a-0010' \  -H 'Content-Type: application/json' \  -d '{  "reason": "Reserva cancelada pelo hóspede"}'
Example Response
{  "id": "ctr_0192f3c1a7b84e2d9f0a1b2c3d4e5f60",  "status": "canceled",  "name": "Locação Villa Trancoso 21–28/11",  "description": null,  "contractTemplateId": "ctt_0192f3a0b1c24d3e8f9a0b1c2d3e4f50",  "contractFileId": null,  "signersExpected": 1,  "signersSigned": 0,  "requiredSignersExpected": 1,  "requiredSignersSigned": 0,  "allowRefusal": true,  "advancedAuth": false,  "refusedReason": null,  "expiresAt": "2026-11-27T15:00:00Z",  "effectiveAt": null,  "signedAt": null,  "canceledAt": "2026-10-29T10:00:00Z",  "hasSignedFile": false,  "tagValues": [    {      "tag": "imovel",      "value": "Villa Trancoso"    },    {      "tag": "inicio",      "value": "21/11/2026"    }  ],  "signers": [    {      "id": "sgn_0192f3c1b2c34d5e6f7a8b9c0d1e2f30",      "sequence": 1,      "role": "payer",      "isRequired": true,      "name": "Ana Souza",      "email": "ana@exemplo.com",      "status": "new",      "timesViewed": 0,      "lastViewedAt": null,      "signedAt": null,      "refusedAt": null,      "signUrl": null    }  ],  "createdAt": "2026-10-28T15:00:00Z",  "updatedAt": "2026-10-28T15:00:00Z"}

Consultar contrato GET

Anterior

Baixar contrato assinado GET

Próxima