Liberar caução
/v1/deposits/{id}/releaseLibera a caução sem cobrança (RELEASED): a autorização no cartão é desfeita.
- Já encerrada → 409
DEPOSIT.ALREADY_CLOSED. - Repetir com a mesma chave devolve a caução liberada.
- Sem
payments:deposits:write→ 403AUTH.ENTITLEMENT_MISSING.
kodanoOAuth payments:deposits:writeAuthorizationBearer <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: payments:deposits:write
id*stringId da caução, dpst_ + 27 letras e dígitos. Inexistente, malformado ou de outro merchant → 404 DEPOSIT.NOT_FOUND.
X-Merchant-Id*stringMerchant 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.
^mrc_[0-9a-f]{32}$Idempotency-Key*stringUUID, 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.
uuidX-Correlation-Id?stringOpcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.
^[A-Za-z0-9._-]{1,64}$Caução liberada.
application/json- response
id*stringdpst_ + 27 letras e dígitos.
status*DepositStatusAWAITING_AUTHORIZATION: aguardando o pagador autorizar o cartão no checkoutUrl. ACTIVE: valor reservado no cartão. RENEWAL_AT_RISK: a renovação automática falhou e será tentada de novo. UNSECURED: sem autorização válida (renovação negada ou cobertura encerrada sem renovar). RELEASED, CAPTURED e REFUNDED são finais.
"AWAITING_AUTHORIZATION""ACTIVE""RENEWAL_AT_RISK""UNSECURED""RELEASED""CAPTURED""REFUNDED"mode*DepositModePREAUTH_RENEWAL: reserva renovada no cartão, tarifa depois. PREAUTH_FEE_UPFRONT: reserva renovada, tarifa cobrada na abertura. IMMEDIATE_CHARGE: o valor é cobrado na abertura e devolvido no encerramento.
"PREAUTH_RENEWAL""PREAUTH_FEE_UPFRONT""IMMEDIATE_CHARGE"autoRenew*booleancontractId*stringcustomerId*|null até a autorização, quando a caução foi aberta com payer.
name*string|nulldescription*string|nullamount*integerint64currency*"BRL"Único valor na v1.
"BRL"coverageStartsAt*stringdate-timecoverageEndsAt*stringdate-timeguaranteeEndsAt*|Até quando a autorização vigente cobre a caução.
date-timecheckoutUrl*|Só em AWAITING_AUTHORIZATION.
uricard*|nullauthorizationExpiresAt*|date-timenextRenewalAttemptAt*|date-timeunsecuredReason*|"RENEWAL_DENIED""EXPIRED_AS_PLANNED"nullfeeAmount*|int64capturedAmount*|int64refundAmount*|int64damageDescription*string|nullcreatedAt*stringdate-timeupdatedAt*stringdate-timecurl -X POST 'https://api.sandbox.kodano.com.br/v1/deposits/dpst_7Hq2LmX9vB4nR8sT1wK6yZ3cP0a/release' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'Idempotency-Key: 4b2e8c1a-9d7f-4e3b-a6c5-0f1e2d3c4b5a' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "id": "dpst_7Hq2LmX9vB4nR8sT1wK6yZ3cP0a", "status": "RELEASED", "mode": "PREAUTH_RENEWAL", "autoRenew": true, "contractId": "ctr_0192f3c1a7b84e2d9f0a1b2c3d4e5f60", "customerId": "cus_0192f3c2aa11bb22cc33dd44ee55ff66", "name": "Caução Villa Trancoso", "description": null, "amount": 500000, "currency": "BRL", "coverageStartsAt": "2026-11-02T00:00:00Z", "coverageEndsAt": "2026-12-05T00:00:00Z", "guaranteeEndsAt": "2026-11-07T15:20:00Z", "checkoutUrl": null, "card": { "brand": "VISA", "lastFour": "4242" }, "authorizationExpiresAt": "2026-11-07T15:20:00Z", "nextRenewalAttemptAt": null, "unsecuredReason": null, "feeAmount": 20000, "capturedAmount": null, "refundAmount": null, "damageDescription": null, "createdAt": "2026-10-28T15:05:00Z", "updatedAt": "2026-10-28T15:05:00Z"}