Demander API - Payment Methods

This article is part of the REST Integration API documentation.

Documentation to consult, insert, update and delete payment methods.

Consultation

List the company’s payment methods. Without filter, considers dataAlteracao from the last 6 months.

Rota: {host}/public/v1/formas-de-pagamento?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Return:

{
  "formasDePagamento": [
    {
      "codigo": "1",
      "descricao": "BOLETO",
      "ativo": 1,
      "valorMinimoPedido": 8.5,
      "percJurosDesconto": 5.0,
      "consideraLimiteCredito": 1,
      "dataAlteracao": "2026-07-15 14:00:00"
    }
  ]
}

Insert or update

POST upsert by key codigo.

Rota: {host}/public/v1/formas-de-pagamento
Método: POST
Body: json

Property	Type	Size	Mandatory	Description
code	string	20	✓	Payment method code. Unique identifier used to insert or update (upsert).
description	string	255	✓	Name of the payment method.
active	int			Values: `0` or `1`. Default on inclusion: `1`.
valorMinimoPedido	decimal			Minimum order value to use this way.
percJurosDesconto	decimal			Interest percentage or discount.
consideraLimiteCredito	int			Values: `0` or `1`. Default on inclusion: `0`.

Body:

{
  "codigo": "1",
  "descricao": "BOLETO",
  "ativo": 1,
  "valorMinimoPedido": 8.5,
  "percJurosDesconto": 5.0,
  "consideraLimiteCredito": 1
}

Return:

{
  "codigo": "1",
  "descricao": "BOLETO",
  "ativo": 1,
  "valorMinimoPedido": 8.5,
  "percJurosDesconto": 5.0,
  "consideraLimiteCredito": 1,
  "dataAlteracao": "2026-07-15 14:00:00"
}

Delete

Remove the payment method.

Rota: {host}/public/v1/formas-de-pagamento?codigo={codigo}
Método: DELETE

Return:

{
  "mensagem": "Registro excluído com sucesso."
}