v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar formas de pagamento

get/paymentMethods

Query parameters

showinteger

Número de itens na página de resultado.

cursorstring

Hash da próxima página.

payment_method_type_idinteger

Filtrar pelo ID do tipo de forma de pagamento: 1: boleto, 2: cartão de crédito, 3: transferência bancária, 4: dinheiro (espécie), 5: cartão de débito, 6: cheque, 7: bitcoin, 8: Invoice internacional, 9: a combinar, 10: débito em conta, 11: PIX.

down_paymentinteger

Filtrar pelo valor percentual pago como entrada da forma do pagamento.

discountinteger

Filtrar pelo valor percentual de desconto da forma de pagamento.

terminteger

Filtrar pelo prazo para primeira parcela da forma de pagamento.

parcelsinteger

Filtrar pela quantidade de parcelas da forma de pagamento.

intervalinteger

Filtrar pelo prazo de demais parcelas da forma de pagamento.

typeinteger

Filtrar pelo tipo de produto da forma de pagamento: 1: produto e serviço, 2: mensalidades recorrentes.

config_activeboolean

Filtrar por formas de pagamento ativas/inativas.

created_at_startstring date-time

Filtrar por registros de pagamento a partir da data e hora de criação informada.

created_at_endstring date-time

Filtrar por registros de pagamento até a data e hora de criação informada.

updated_at_startstring date-time

Filtrar por registros de pagamento a partir da data e hora de atualização informada.

updated_at_endstring date-time

Filtrar por registros de pagamento até a data e hora de atualização informada.

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 123,
      "payment_method_type_id": 1,
      "description": "dinheiro",
      "discount": 10,
      "temp": 1,
      "term": 1,
      "interval": 10,
      "parcels": 10,
      "type": 10,
      "down_payment": 10,
      "json": 1,
      "config_active": 10,
      "created_at": "2017-06-12 15:14:00",
      "updated_at": "2017-06-12 15:14:00"
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJpZ......XRlbXMiOnRydWV9"
    }
  }
}