Consultar pagamento
/v1/payments/{id}Devolve o pagamento (PIX, boleto ou cartão). failure só em FAILED; o instrumento recuperado pelo fallback aparece aqui. Leitura sem cache.
X-Merchant-Id é obrigatório com credencial de organização; com credencial de merchant é opcional (ausente = o próprio merchant).
AuthorizationBearer <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:pix:read
id*stringId do pagamento (pay_…). Malformado → 404.
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}$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}$Pagamento.
application/json- response
Mesmo objeto no 201 dos três POST de criação, no 200 do cancel, no detalhe, em cada item da lista e em data.object dos eventos de pagamento. O bloco do método vem preenchido; os dos outros métodos vêm null.
id*stringpay_ + 28 alfanuméricos.
^pay_status*PaymentStatusNove status mutuamente exclusivos. Precedência entre os derivados de sucesso: CHARGEBACK > REFUNDED > PARTIALLY_REFUNDED > CAPTURED/SUCCEEDED > AUTHORIZED.
"PENDING""AUTHORIZED""CAPTURED""SUCCEEDED""FAILED""CANCELED""REFUNDED""PARTIALLY_REFUNDED""CHARGEBACK"statusReason*|PROVIDER_PENDING (PENDING sem instrumento após timeout do provedor), EXPIRED (CANCELED por expiração), CAPTURE_FAILED (CANCELED porque a captura imediata falhou).
"PROVIDER_PENDING""EXPIRED""CAPTURE_FAILED"nullmethod*PaymentMethod"PIX""BOLETO""CARD"amount*integerCentavos pedidos na criação.
currency*"BRL"Único valor na v1.
"BRL"description*|length <= 140customer*pix?|nullboleto?|nullcard?|nullnextAction?|nullfailure*|nullrefundedAmount*integerSoma dos estornos SUCCEEDED (o ajuste de captura parcial não conta).
refundedAt*|date-timepaymentLinkId*|ord_ quando o pagamento veio de link.
metadata*Até 20 chaves ^[A-Za-z0-9_.-]{1,40}$, valores string ≤ 500; devolvido tal qual.
properties <= 20createdAt*stringdate-timeupdatedAt*stringdate-timecurl -X GET 'https://api.sandbox.kodano.com.br/v1/payments/string' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "id": "pay_2wMqZcUDIh7yfJs1ON43xKmTecQo", "status": "PARTIALLY_REFUNDED", "statusReason": null, "method": "CARD", "amount": 25000, "currency": "BRL", "description": "Reserva 4471", "customer": { "id": "cus_iGFfWd3hjOkYRBMe", "name": "Ana Souza", "document": "123******09" }, "pix": null, "boleto": null, "card": { "id": "card_WrXPvhsBkDa9U4UqGWlG6g3Ot1O", "brand": "VISA", "last4": "4242", "installments": 3, "capturedAmount": 20000, "capturedAt": "2026-10-16T15:00:00Z" }, "nextAction": null, "failure": null, "refundedAmount": 5000, "refundedAt": "2026-10-17T09:10:00Z", "paymentLinkId": null, "metadata": { "booking": "4471" }, "createdAt": "2026-10-16T13:10:00Z", "updatedAt": "2026-10-17T09:10:00Z"}