Consultar evento
/v1/events/{id}Devolve o envelope do evento; data.object retrata o recurso no instante do fato (o estado atual está no GET do recurso).
X-Merchant-Id é opcional: credencial de organização sem o header atua no escopo ORGANIZATION (organização e todos os merchants do tenant); com o header, no escopo MERCHANT daquele merchant. Credencial de merchant atua sempre no próprio merchant.
kodanoOAuth events:events:readAuthorizationBearer <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: events:events:read
id*stringId do evento (evt_…).
X-Merchant-Id?stringOpcional. Credencial de organização sem o header atua no nível da organização; com o header, no merchant indicado. Fora do tenant, inexistente ou diferente do merchant da credencial de merchant → 403 MERCHANT.FORBIDDEN.
^mrc_[0-9a-f]{32}$X-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}$Evento.
application/json- response
Envelope: corpo assinado do webhook, item de GET /v1/events e resposta de GET /v1/events/{id}.
id*stringIgual ao header X-Kodano-Event-Id; chave de deduplicação.
^evt_type*EventType"payment.succeeded""payment.failed""payment.refunded""chargeback.received""withdrawal.completed""withdrawal.failed""fx.operation.settled""fx.operation.expired""fx.operation.failed""fx.operation.action_required""fx.operation.refunded""settlement.closed""webhook_endpoint.disabled""ping"apiVersion*string2026-10-01.
createdAt*stringdate-timeenvironment*string"sandbox""production"merchantId*|mrc_…; null em evento de organização.
data*curl -X GET 'https://api.sandbox.kodano.com.br/v1/events/string' \ -H 'X-Merchant-Id: mrc_e3cc4727054da558273162251e310d29' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "id": "evt_eLAeXfIkpXkuN51gMG1J3aYxprFLfIAo", "type": "payment.refunded", "apiVersion": "2026-10-01", "createdAt": "2026-10-16T18:30:02Z", "environment": "sandbox", "merchantId": "mrc_e3cc4727054da558273162251e310d29", "data": { "object": { "id": "pay_Nj7ZJCZ9jM7SGGmnjGl9UAXLW7BpYwCL", "status": "PARTIALLY_REFUNDED", "method": "PIX", "amount": 15990, "currency": "BRL", "description": "Pedido 123", "customer": { "id": "cus_Lbfbv3xA5PQh8H5jKlF7yXqRNJxlSZXf", "name": "Ana Souza", "document": "123******09" }, "pix": { "qrCode": "00020101021226840014br.gov.bcb.pix2562pix.exemplo.com.br/qr/v2/cobv/5c1b2a3d4e5f60718293a4b5c6d7e8f95204000053039865802BR5911ACME LTDA6009SAO PAULO62070503***6304A1B2", "copyPaste": "00020101021226840014br.gov.bcb.pix2562pix.exemplo.com.br/qr/v2/cobv/5c1b2a3d4e5f60718293a4b5c6d7e8f95204000053039865802BR5911ACME LTDA6009SAO PAULO62070503***6304A1B2", "expiresAt": "2026-10-16T14:00:00Z", "endToEndId": "E18236120202610161302s0a1b2c3d4e" }, "failure": null, "statusReason": null, "refundedAmount": 5000, "refundedAt": "2026-10-16T18:30:00Z", "paymentLinkId": null, "metadata": { "orderRef": "123" }, "createdAt": "2026-10-16T13:00:00Z", "updatedAt": "2026-10-16T18:30:00Z" }, "refund": { "id": "ref_EN9MqxQZIpd3nf12U7pIXifnAXOs7j69", "amount": 5000, "currency": "BRL", "status": "SUCCEEDED", "reason": null, "failure": null, "createdAt": "2026-10-16T18:29:48Z", "updatedAt": "2026-10-16T18:30:00Z" } }}