Voltar ao site
Pagamentos

Tarifas do pagamento

GET/v1/payments/{id}/fees

Bruto, líquido e tarifas do pagamento. Sem lançamento financeiro → status: PENDING com fees: []; boleto pago fica PENDING. Sem MDR na v1.

X-Merchant-Id é obrigatório com credencial de organização; com credencial de merchant é opcional (ausente = o próprio merchant).

Authorization

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: payments:pix:read

Path Parameters

id*string

Id do pagamento (pay_…). Malformado → 404.

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}$
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}$

Response Body

Tarifas.

application/json
  1. response
paymentId*string
Match^pay_
currency*"BRL"

Único valor na v1.

Value in"BRL"
grossAmount*integer
netAmount*integer
status*string
Value in"PENDING""ESTIMATED""SETTLED""PARTIALLY_SETTLED"
fees*array<>
Example Request
curl -X GET 'https://api.sandbox.kodano.com.br/v1/payments/string/fees' \  -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \  -H 'X-Correlation-Id: erp-7f3a-0010'
Example Response
{  "paymentId": "pay_Lq7Tz2WcR9hN4bVx1sKe6pYd3MfA",  "currency": "BRL",  "grossAmount": 25000,  "netAmount": 24375,  "status": "ESTIMATED",  "fees": [    {      "type": "KODANO_FEE",      "amount": 625    }  ]}