VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa

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.

Pontos-chave
  • Todas as rotas exigem um usuário administrador (HTTP Basic e-mail:chave_de_api ou Bearer). Veja Autenticação.
  • As rotas existem em /api/v1.0/... e também sem a versão (/api/...).
  • Formas de pagamento usam UUID como id. Regras de imposto usam inteiro.
  • Credenciais do meio de pagamento (chaves secretas, tokens, senhas) nunca saem na API: são retiradas de processor_params antes da resposta.
  • Valores em dinheiro são decimais (a_surcharge), nunca centavos.
  • Erros têm o formato {"message":"...","status":4xx}.

Como funciona

  1. Leia o que a loja já tem

    GET /payments e GET /taxes devolvem os cadastros em páginas.

  2. Crie ou ajuste

    Crie uma forma de pagamento com POST /payments e altere com PUT /payments/{id}. As regras de imposto seguem o mesmo desenho.

  3. Desative em vez de apagar

    Mude o status para D quando só quiser tirar uma opção do checkout. Apague apenas o que nunca foi usado.

Conceitos

Status

LetraSignificado
AAtivo
DDesativado

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étodoCaminhoPara que servePágina
GET/api/v1.0/paymentsListar formas de pagamentoFormas de pagamento
GET/api/v1.0/payments/{id}Consultar uma formaFormas de pagamento
POST/api/v1.0/paymentsCriar uma formaFormas de pagamento
PUT/api/v1.0/payments/{id}Alterar uma formaFormas de pagamento
DELETE/api/v1.0/payments/{id}Remover uma formaFormas de pagamento
GET/api/v1.0/taxesListar regras de impostoRegras de imposto
GET/api/v1.0/taxes/{id}Consultar uma regraRegras de imposto
POST/api/v1.0/taxesCriar uma regraRegras de imposto
PUT/api/v1.0/taxes/{id}Alterar uma regraRegras de imposto
DELETE/api/v1.0/taxes/{id}Remover uma regraRegras 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 pelo PUT.
  • Mandar status: "active" em imposto. Em regras de imposto só D desativa; 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; page e items_per_page só aparecem como eco em params.

Próximos passos

Formas de pagamento
Listar, criar e manter o que o checkout oferece.
Regras de imposto
O cadastro de impostos da loja.
Anterior
Carrinhos
Próxima
Formas de pagamento
Nesta página
  • Como funciona
  • Conceitos
  • Status
  • Tipo de processamento
  • Rotas
  • Erros comuns
  • Próximos passos