API de Demander: métodos de pago

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar métodos de pago.

Consulta

Enumere los métodos de pago de la empresa. Sin filtro, considera dataAlteracao de los últimos 6 meses.

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

Precaución

Paginación

• pagina — base 1 (predeterminado 1)
• limite — predeterminado 100, máximo 500

Filtros

• Formato filtroDataAlteracao — Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (predeterminado >=)

Retorno:

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

Insertar o actualizar

POST inserción mediante la tecla codigo.

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

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	cadena	20	✓	Código de método de pago. Identificador único utilizado para insertar o actualizar (upsert).
descripción	cadena	255	✓	Nombre del método de pago.
activo	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 1.
valorMinimoPedido	decimal			Valor mínimo de pedido para utilizar de esta manera.
percJurosDesconto	decimal			Porcentaje de interés o descuento.
consideraLimiteCredito	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 0.

Precaución

Inclusión

• Es necesario enviar todos los atributos que sean obligatorios. Devolver 201.

Actualización

• Sólo el atributo codigo es obligatorio. Devuelve 200.

Cuerpo:

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

Retorno:

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

Eliminar

Eliminar el método de pago.

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

Retorno:

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