Skip to main content
Draft: specification in progress. Endpoints and fields may change.
v0.2.0-rascunho

Usage-based pricing and client-defined rules

  • Pricing: TESA now charges as software, by API call volume. Standard plan by monthly call tiers; Enterprise with negotiated volume and a dedicated SLA. Nothing is charged on balance, yield or principal.
  • GET /organizacao: taxa_sobre_rendimento removed; limite_chamadas_mes and chamadas_mes_atual added.
  • GET /rendimento: taxa_percentual, taxa_valor and rendimento_liquido removed; rendimento_bruto renamed to rendimento_total. Yield is informational only.
  • GET /cobrancas: now lists API usage invoices (periodo, plano, chamadas, valor, status), with the fat_ prefix. Paths are unchanged.
  • Webhook cobranca.emitida renamed to fatura.emitida.
  • Allocation policy: no preselected allocation. The company defines the proportions and the rebalancing rules (regras, with gatilho and limite). TESA does not recommend allocations.
  • Proposals: origem changes from tesa/cliente to regra (generated by a rule in the company’s policy) and manual, with the new regra_id field. The alocacao.proposta event now means a rule in your policy generated a transaction.
v0.1.0-rascunho

Initial draft

  • First public version of the API proposal, with no live endpoints yet.
  • Resources: organization, wallets, positions, allocation policy, proposals, redemptions, records, yield, charges and webhooks.
  • Bearer key authentication, with optional HMAC signing and Idempotency-Key.
  • OpenAPI 3.1 specification published in the API reference.