Taxas de gateway
Quanto cada forma de pagamento custa à loja, usado para calcular o lucro real dos pedidos.
O gateway cobra uma taxa de cada transação (por exemplo, 2,5% mais R$ 1,50 no boleto). Cadastrar essas taxas faz o relatório de lucro mostrar o resultado depois do custo de pagamento. As taxas não são cobradas do cliente nem alteram o preço: servem só para análise.
Consultar taxas
Devolve a taxa que cada forma de pagamento custa à loja. Esses números alimentam o relatório de lucro real, que desconta a taxa do gateway da receita de cada pedido.
/api/v1/admin/payment-feesAdminLista as taxas de gateway configuradas
Autenticação: Authorization: Bearer <token> de um administrador com o privilégio view_reports. Requer o módulo analytics ativo.
Sem parâmetros.
Exemplo de requisição
Resposta
A resposta é uma lista JSON (não um objeto), ordenada por payment_method. Vazia: [].
Campos da resposta
[].payment_methodstringpix, boleto, credit_card).[].percent_bpsinteger250 = 2,5%).[].fixed_centsintegerErros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token ou token inválido | {"error":"missing authorization header"} |
| 403 | Sem o privilégio exigido, ou módulo desligado | {"error":"module_disabled","module":"analytics"} / {"error":"insufficient privileges","required":"view_reports"} |
| 500 | Falha na consulta | {"error":"failed to list payment fees","detail":"..."} |
Substituir taxas
Grava as taxas e substitui o conjunto inteiro: formas de pagamento que não estiverem no corpo têm a taxa apagada.
/api/v1/admin/payment-feesAdminDefine as taxas de gateway
Autenticação: Authorization: Bearer <token> de um administrador com o privilégio view_reports. Requer o módulo analytics ativo.
Corpo da requisição
[]arrayobrigatóriopayment_method vazio são ignoradas.[].payment_methodstringobrigatório[].percent_bpsintegerpadrão: 0[].fixed_centsintegerpadrão: 0Exemplo de requisição
Resposta
Campos da resposta
okbooleantrue quando gravou.Erros
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem token ou token inválido | {"error":"missing authorization header"} |
| 403 | Sem o privilégio exigido, ou módulo desligado | {"error":"module_disabled","module":"analytics"} / {"error":"insufficient privileges","required":"view_reports"} |
| 400 | Corpo que não é uma lista JSON válida | {"error":"invalid body","detail":"..."} |
| 500 | Falha ao gravar | {"error":"failed to save payment fees","detail":"..."} |