PipeRun API icon

PipeRun API

Interact with the PipeRun CRM API.

Actions220

Payment Methods → Adicionar Metodo De Pagamento

AI-generated

Summary

Adds a payment method to PipeRun by sending a request with the required payment method type ID, description, and usage type. Optional settings can configure its status, discount, installment schedule, and custom body or query parameters.

Inputs

  • Payment Method Type Id (required) — Numeric payment method ID: 1 boleto, 2 credit card, 3 bank transfer, 4 cash, 5 debit card, 6 cheque, 7 bitcoin, 8 international invoice, 9 to be agreed, 10 account debit, or 11 PIX.
  • Description (required) — Description of the payment method.
  • Type (required) — Choose where the method is available: 1 for products/services or 2 for recurring revenue (MRR).
  • Config Active — Whether the payment method is active; defaults to true.
  • Discount — Discount percentage; defaults to 0.
  • Term — Days until the first installment; defaults to 0.
  • Interval — Days between subsequent installments; defaults to 0.
  • Parcels — Number of installments; defaults to 0.
  • Down Payment — Down payment percentage; defaults to 0.
  • Custom Body Fields / Custom Body (JSON) — Add root-level request body fields individually or merge a JSON object into the request body.
  • Custom Query Parameters / Custom Query (JSON) — Append query parameters individually or merge them from a JSON object.
  • Request Options — Optional batching, SSL certificate validation setting, proxy, and request timeout controls.

Output shape

A single API response item.

The source delegates the request and response handling to the generated OpenAPI node framework; the operation-specific response fields are not shown here.

Links

Discussion