v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Adicionar forma de pagamento

post/paymentMethods

Request body

payment_method_type_idinteger required

ID do tipo de método 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.

descriptionstring required

Descrição do método de pagamento.

typeinteger required

Método de pagamento disponível para: 1: produtos/serviços (P&S), 2: receitas recorrentes (MRR)

config_activeboolean

Formas de pagamento ativas/inativas.

discountnumber float

Valor percentual do desconto.

terminteger

Prazo para a 1ª parcela (em dias).

intervalinteger

Prazo para demais parcelas (em dias).

parcelsinteger

Número de parcelas.

down_paymentnumber float

Valor percentual de entrada.

Response

201

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Created",
  "data": {
    "id": 748,
    "payment_method_type_id": 1,
    "description": "dinheiro",
    "discount": 100.5,
    "temp": 1,
    "term": 1,
    "interval": 10,
    "parcels": 10,
    "type": 10,
    "down_payment": 10,
    "json": 1,
    "config_active": 10
  }
}