Como funciona
O platform fee é simples de configurar e opera em dois níveis:- Ativação: Uma flag no merchant habilita ou desabilita a aplicação das taxas. Enquanto desativada, nenhuma regra é aplicada nas transações, dando total controle sobre quando começar a cobrar.
- Regras por método de pagamento: Cada regra define a taxa para um método específico (
credit,pix,boleto). Para cartão de crédito, as regras são configuradas por faixa de parcelamento.
Faixas de parcelamento para crédito
Para o método de pagamentocredit, o campo installment é obrigatório e o valor informado (1 a 24) é automaticamente associado a uma das quatro faixas:
Cada merchant pode ter no máximo uma regra por faixa. O valor original informado é preservado na resposta da API.
Exemplo
Se você criar uma regra cominstallment: 5, ela cobrirá a faixa 2x a 6x. Ao tentar criar outra regra com installment: 3 (mesma faixa), a API retornará 409 Conflict com a mensagem indicando que já existe uma regra para a faixa 2x a 6x.
Outros detalhes
- O método de pagamento
defaultnão aceita o campoinstallment. Ele funciona exclusivamente como regra de fallback para métodos sem regra específica. - Para
pixeboleto, uma regra por método, sem parcelamento.
Novos endpoints
PATCH /v1/merchants/{merchantId}/platform-fee/enabled: Ativar ou desativar platform feePOST /v1/merchants/{merchantId}/platform-fee: Criar regras de taxaGET /v1/merchants/{merchantId}/platform-fee: Listar regras ativasPUT /v1/merchants/{merchantId}/platform-fee: Atualizar regras existentesDELETE /v1/merchants/{merchantId}/platform-fee/{platformFeeId}: Remover regras