## Definição

A calculadora de taxas é um simulador criado pelo time do Pagar.me para ajudar o cliente a entender quais serão as taxas cobradas de suas vendas no cartão de crédito e sugerir qual valor que ele deve cobrar de seu cliente para receber uma quantia determinada previamente.

Quais clientes poderão utilizar o endpoint?

Qualquer cliente que venda no cartão de crédito, tendo ou não os modelos de antecipação spot, automática e compulsória.

Como utilizar o endpoint da calculadora de taxas?

Para simular uma transação no cartão de crédito devemos usar a rota: /transactions/fee-calculator utilizando o method GET.

## Simulando uma transação de cartão de crédito

**Exemplo 1:**

Suponha que você queira ter previsibilidade do valor líquido que irá receber em uma transação de cartão de crédito de R$ 78,00 à vista, cuja bandeira é Mastercard e o método de captura é “Ecommerce”, basta passar o payload, como mostrado abaixo:



**Exemplo 2:**

Suponha que você queira receber uma sugestão de atribuição de preço em um produto/serviço e, para isso, você já sabe que deve receber líquido a quantia de R$ 100,00. Sendo assim, basta passar o payload com os atributos da transação:



Assim que a requisição for feita, as seguintes taxas configuradas serão capturadas no cálculo:

**fee:** taxa de MDR **anticipation_fee:** taxa de antecipação (caso possua antecipação) **fraud_coverage_fee: **taxa de cobertura de fraude (caso possua cobertura de fraude)

É dessa forma que você consegue simular as taxas que serão cobradas em uma transação de cartão de crédito. Viu como é simples? ;-)

Payment_method disponível:

Atualmente, o único payment_method disponível é o objeto credit_card. O time do Pagar.me já está trabalhando para que no futuro seja possível simular transações com outros métodos de pagamento, como Pix, cartão de débito, entre outros.

## Request | Parâmetros

ParâmetroPadrãoDescriçãoObrigatoriedade
api_keystringChave da APISim
amountintValor a ser simulado, deve ser passado em centavos. Ex: R$ 10.00 = 1000. Devendo ser no mínimo 1 centavo (1)Sim
fee_responsibilitystringPode receber: “buyer” ou “merchant”. “fee_responsibility”: “merchant”, significa que o cliente Pagar.me paga as taxas, ou seja, deve-se passar em ‘amount’ o valor que quer cobrar de seu comprador; “fee_responsibility”: “buyer”, significa que o comprador paga as taxas, ou seja, deve-se passar em ‘amount’ o valor líquido que se deseja receber.Sim
credit_cardobjetoMétodo de pagamento da transação. Atualmente, só aceita um tipo: "credit_card", onde armazena os seguintes atributos: “installments”: deve-se informar o número de parcelas; “card_brand”: campo para informar a bandeira do cartão de crédito; “capture_method”: campo para informar o método de captura.Sim

**Propriedades do objeto credit_card:**

AtributosPadrãoDescriçãoObrigatoriedade
installmentsintNúmero de parcelas da transação, sendo no mínimo 1 e máximo 12.Sim
card_brandstringBandeira do cartão, podendo ser: ['amex','aura','diners','discover','elo','hipercard','jcb','mastercard','visa']Sim
capture_methodstringMétodo de captura, podendo ser: ['ecommerce','emv','magstripe','emv_contactless','magstripe_contactless',]Atributo não obrigatório. Caso não seja passado nenhum capture_method, o método de captura default é o ecommerce.

## Response | Parâmetros

ParâmetroPadrãoDescrição
delayint ou array de números inteirosPrazo de recebimento configurado. int: para clientes com antecipação automática ou compulsória; array: para clientes sem antecipação e com antecipação spot. (Fluxo natural de liquidação vinculadas às transações)
total_fee_percentagefloatPercentual total de taxas.
total_fee_amountintValor total das taxas (em centavos).
amount_receivedintValor líquido que o lojista receberá (em centavos).
amount_chargedintValor sugerido (em centavos) que o lojista deve cobrar de seu cliente para obter o valor líquido informado em amount.