Skip to main content
GET
cURL

​
Escopo

​
O que é este endpoint?

É a versão consultável por API da tela Taxas e Prazos do painel. Para cada método de pagamento, ele devolve os três números que a tela mostra:
  • o percentual cobrado sobre a venda aprovada — o 4,99% da linha do cartão;
  • o valor fixo somado a ele — o + R$ 2,49 por venda aprovada;
  • o prazo de recebimento em dias — o selo Recebimento: 15 dias.
Vem junto a tabela de juro do parcelamento no cartão, de 1x a 18x.
A operação lê sempre a conta dona do token. Não existe parâmetro de produtor: não há como consultar a tabela de outra conta, e mandar um identificador na query não muda o resultado.

​
Para que serve

Calcular o líquido antes de vender

Aplique percentual e fixo sobre o valor da oferta para mostrar ao seu time, ou ao seu cliente, quanto de fato entra por venda em cada método.

Projetar o fluxo de caixa

Use o prazo de recebimento para estimar quando o dinheiro de uma venda fica disponível e planejar o caixa do mês.

Escolher o método a oferecer

Compare custo e prazo lado a lado. Pix costuma custar menos e liberar antes; cartão custa mais e libera depois, mas converte melhor no parcelado.

Montar simulador de parcelamento

Use a tabela de 1x a 18x para exibir, na sua própria interface, o juro de cada opção de parcela.

​
De onde vem cada número na tela

Os nomes na API são os mesmos que você já usa em paymentMethod de POST /public_api/payments/. Como o painel usa rótulos comerciais, esta é a correspondência:
A lista vem completa e sempre na mesma ordem, com os dez métodos, mesmo os que sua conta não usa. Método sem taxa vigente configurada vem com os três valores em null — é o mesmo caso em que o painel escreve “Não configurado”. Pode iterar a lista sem medo de ela mudar de tamanho entre chamadas.

​
A taxa que o comprador paga

Tudo em paymentMethods sai do seu repasse. customerFees é a exceção: são taxas que a Cakto cobra do comprador, somadas ao total que ele paga no checkout. Elas não reduzem o seu líquido. Hoje há exatamente uma: O valor é por pedido, não por parcela, e não muda com o valor da venda.
Não some customerFees no seu cálculo de líquido. O erro simétrico também custa dinheiro: se você monta a tela de preço para o comprador, o total dele é o valor do produto mais amount — quem esquece mostra um preço menor do que o cobrado.
A lista reflete a sua conta, e pode vir vazia. Em algumas contas esta taxa é cobrada do produtor em vez do comprador, ou não é cobrada — nesses casos ela simplesmente não aparece em customerFees. Por isso leia a lista em vez de assumir os R$ 0,99: customerFees: [] é uma resposta válida e significa que nenhuma taxa é cobrada do seu comprador.Esta é também a razão de customerFees ser uma lista e não um campo fixo: a composição pode mudar sem quebrar quem já integra.

​
Como ler os valores

4.99 significa 4,99%, e não 0,0499. Para aplicar sobre o valor da venda, divida por 100:
O 0.0 do Pix é taxa percentual zero de verdade — a cobrança daquele método é só o valor fixed.
null quer dizer “sem taxa vigente configurada para esse método na sua conta”, exatamente o “Não configurado” do painel. Tratar null como 0 faz sua conta de líquido dar um número que a Cakto nunca prometeu. Se um método que você usa aparece null, fale com o suporte.
É o mesmo número do selo Recebimento: do painel: dias corridos, contados da criação do pedido, segundo o que está configurado hoje na sua conta.É uma projeção, não uma garantia por venda: a venda pode ser processada por outra adquirente, e antecipação altera o prazo. A data efetiva de cada pedido está em releaseDate, no próprio pedido — veja Obter Pedido.releaseDays: 0 é liberação no mesmo dia, o que o painel exibe como “Instantâneo”.
interestPercentage é o juro-base que a Cakto cobra para aquele número de parcelas, também em pontos percentuais. installments: 1 costuma vir 0.0 — à vista não tem juro de parcelamento.Ele não inclui o juro adicional que você mesmo pode ter configurado para cobrar do comprador no parcelado. Esse é seu, vale de 2x a 12x e sai em Consultar Juro Adicional. São dois números somados na mesma parcela: para exibir o valor real ao comprador, some os dois; tratar este aqui como se já incluísse o seu erra a conta.
percentage, fixed e interestPercentage chegam como número (2.49), não como string. Em linguagens onde isso importa, converta para decimal antes de fazer aritmética financeira, em vez de acumular em ponto flutuante.

​
Resposta

​
Exemplo de resposta

creditCardInstallments foi encurtado no exemplo acima. Na resposta real ele traz as 18 linhas, de 1 a 18, sem buracos.

​
Respostas de erro

409 e 503 pedem reações opostas — não trate os dois como “deu erro, tenta de novo”.409 tem um único motivo nesta operação: a conta ainda não concluiu o cadastro de recebimento, então não existe tabela de taxas para responder. Repetir a chamada não resolve; quem resolve é o produtor, no Painel Cakto.503 é transitório: repita com backoff. Se persistir, é incidente do nosso lado — fale com o suporte.

​
Exemplo de requisição

​
Boas práticas

  • Consulte uma vez e guarde. Sua tabela de taxas muda raramente — normalmente só quando o plano ou o contrato muda. Chamar este endpoint a cada pedido gasta seu limite de requisições sem trazer informação nova. Guarde o resultado e atualize periodicamente.
  • Trate null explicitamente antes de qualquer conta, em vez de deixar a linguagem convertê-lo para zero em silêncio.
  • Não use releaseDays para prometer data ao cliente final. Para a data de um pedido específico, leia releaseDate em Obter Pedido.
  • Não deduza a taxa a partir do valor recebido de uma venda antecipada. Antecipação tem custo próprio, que não sai neste endpoint; a conta não vai fechar.

Authorizations

​
Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Response

Taxas e prazos vigentes da conta autenticada, por método de pagamento.

​
paymentMethods
object[]
required

Taxas e prazos por método de pagamento. A lista traz sempre todos os métodos suportados, na mesma ordem; método sem taxa configurada aparece com os três valores em null.

​
creditCardInstallments
object[]
required

Juro-base da Cakto por número de parcelas no cartão, de 1x a 18x.

​
customerFees
object[]
required

Taxas que a Cakto cobra do comprador nas vendas desta conta, somadas ao total que ele paga. Não saem do seu repasse. A lista reflete a sua conta: se a taxa foi transferida para você ou isentada, ela não aparece aqui. Pode vir vazia.