Criar link de pagamento
/v1/payment-linksCria um link de checkout hospedado. Com customer → uso único (maxPayments 1). Sem customer → uso múltiplo com teto maxPayments (padrão 1). Captura automática, sem split, itens, caução ou repasse de tarifa. externalReference é o dedupe recomendado quando a chave se perde.
X-Merchant-Id é obrigatório com credencial de organização; com credencial de merchant é opcional (ausente = o próprio merchant).
kodanoOAuth payments:links: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:links:write
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}$application/json- body
amount*integer100 <= value <= 100000000currency*"BRL"Único valor na v1.
"BRL"name?stringlength <= 255description?stringlength <= 255methods*array<>1 <= items <= 3maxPayments?integer1 <= value <= 100001maxInstallments?integerSó com CARD em methods.
1 <= value <= 12expiresAt?stringEntre agora + 5 min e agora + 180 dias; ausente = sem vencimento.
date-timecustomer?|{ id } ou cliente inline; os dois juntos → VALIDATION.ONE_OF.
externalReference?stringlength <= 100successUrl?stringurilength <= 255failureUrl?stringurilength <= 255metadata?Até 20 chaves ^[A-Za-z0-9_.-]{1,40}$, valores string ≤ 500; devolvido tal qual.
properties <= 20Link criado (ou replay).
application/json- response
id*stringord_ + 28 caracteres.
^ord_url*stringCheckout hospedado e anônimo, fora do host da API.
uristatus*PaymentLinkStatus"ACTIVE""COMPLETED""EXPIRED""CANCELED"amount*integer100 <= value <= 100000000currency*"BRL"Único valor na v1.
"BRL"name*|length <= 255description*|length <= 255methods*array<>1 <= items <= 3maxPayments*integerSempre 1 com customer.
1 <= value <= 10000paymentsCount*integerPode passar de maxPayments.
maxInstallments*|1 <= value <= 12expiresAt*|null = sem vencimento.
date-timecustomer*|nullexternalReference*stringÚnica por merchant; gerada quando omitida.
length <= 100successUrl*|length <= 255failureUrl*|length <= 255metadata*|nullcreatedAt*stringdate-timeupdatedAt*stringdate-timecurl -X POST 'https://api.sandbox.kodano.com.br/v1/payment-links' \ -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 '{ "amount": 15990, "currency": "BRL", "name": "Plano anual", "description": "Assinatura anual do plano Pro", "methods": [ "PIX", "CARD" ], "maxPayments": 1, "maxInstallments": 3, "expiresAt": "2026-10-23T13:00:00Z", "customer": { "id": "cus_8kQ2mZ7xW1pL4nR0" }, "externalReference": "pedido-123", "successUrl": "https://loja.example.com/obrigado", "failureUrl": "https://loja.example.com/pagamento-falhou", "metadata": { "orderRef": "123" }}'{ "id": "ord_2mK9xQ7vR4tL8nW1pZ6cY3bH5jD0", "url": "https://pay.kodano.com.br/8b1f6c0e-3d2a-4f7b-9c1e-5a6d7e8f9a0b", "status": "ACTIVE", "amount": 15990, "currency": "BRL", "name": "Plano anual", "description": "Assinatura anual do plano Pro", "methods": [ "PIX", "CARD" ], "maxPayments": 1, "paymentsCount": 0, "maxInstallments": 3, "expiresAt": "2026-10-23T13:00:00Z", "customer": { "id": "cus_8kQ2mZ7xW1pL4nR0", "name": "Ana Souza", "document": "123******09" }, "externalReference": "pedido-123", "successUrl": "https://loja.example.com/obrigado", "failureUrl": "https://loja.example.com/pagamento-falhou", "metadata": { "orderRef": "123" }, "createdAt": "2026-10-16T13:00:00Z", "updatedAt": "2026-10-16T13:00:00Z"}