Pagamentos e impostos
Visão geral das rotas que mantêm as formas de pagamento e as regras de imposto da loja na API compatível com a Venddor 1.0.
Duas configurações da loja têm rotas próprias na API compatível com a Venddor 1.0. As formas de pagamento definem o que o cliente pode escolher no checkout (Pix, boleto, cartão, pagamento na entrega). As regras de imposto são os cadastros de imposto que a loja aplica aos produtos. Um ERP ou um painel externo usa estas rotas para espelhar essa configuração ou para criá-la sem abrir o painel.
Como funciona
- Leia o que a loja já tem
GET /paymentseGET /taxesdevolvem os cadastros em páginas. - Crie ou ajuste
Crie uma forma de pagamento com
POST /paymentse altere comPUT /payments/{id}. As regras de imposto seguem o mesmo desenho. - Desative em vez de apagar
Mude o status para
Dquando só quiser tirar uma opção do checkout. Apague apenas o que nunca foi usado.
Conceitos
Status
| Letra | Significado |
|---|---|
A | Ativo |
D | Desativado |
Na escrita de formas de pagamento, A, active e enabled ativam; qualquer outro valor desativa. Nas regras de imposto, qualquer valor diferente de D deixa a regra ativa.
Tipo de processamento
Toda forma de pagamento tem um tipo (venddor_processor_type): online (gateway, como Pix e cartão), offline (pagamento na entrega, transferência) ou invoiced (boleto faturado, com parcelas). O campo processor_type, por compatibilidade, vale sempre P.
Rotas
| Método | Caminho | Para que serve | Página |
|---|---|---|---|
| GET | /api/v1.0/payments | Listar formas de pagamento | Formas de pagamento |
| GET | /api/v1.0/payments/{id} | Consultar uma forma | Formas de pagamento |
| POST | /api/v1.0/payments | Criar uma forma | Formas de pagamento |
| PUT | /api/v1.0/payments/{id} | Alterar uma forma | Formas de pagamento |
| DELETE | /api/v1.0/payments/{id} | Remover uma forma | Formas de pagamento |
| GET | /api/v1.0/taxes | Listar regras de imposto | Regras de imposto |
| GET | /api/v1.0/taxes/{id} | Consultar uma regra | Regras de imposto |
| POST | /api/v1.0/taxes | Criar uma regra | Regras de imposto |
| PUT | /api/v1.0/taxes/{id} | Alterar uma regra | Regras de imposto |
| DELETE | /api/v1.0/taxes/{id} | Remover uma regra | Regras de imposto |
Erros comuns
- Esperar as credenciais do gateway na leitura. Elas são sempre removidas de
processor_params. Para trocar uma credencial, grave de novo peloPUT. - Mandar
status: "active"em imposto. Em regras de imposto sóDdesativa; qualquer outro valor deixa a regra ativa. - Confundir os dois tipos de id. O id da forma de pagamento é UUID; o id da regra de imposto é um inteiro.
- Esperar paginação do servidor em
/taxes. A lista traz todas as regras;pageeitems_per_pagesó aparecem como eco emparams.