Adapay Charge icon

Adapay Charge

Manage charges in Adapay

Actions4

Create

AI-generated

Summary

Create a new charge in Adapay either as a one-time (unique) or recurring (recurrence) charge for specified products and customers, with configurable payment methods and optional financial details.

Inputs

  • chargeType (required) — Select whether the charge is a unique (one-time or installments) or recurring charge.
  • items (required) — Define one or more products to charge for, each referencing an existing product ID, with optional override for price and quantity.
  • clients (required) — List one or more existing customer IDs who will receive the charges; each customer receives a separate charge.
  • billingTypes (required) — Select one or more payment methods allowed for the customer to pay this charge (e.g., Boleto Bancário, PIX, Credit Card, Debit Card).
  • dueDate (required) — For unique charges only, set the due date for the payment.
  • installments (required) — For unique charges only, set the number of installments (1 means a single payment).
  • recurrenceFrequency (required) — For recurring charges only, select how often the charge recurs (e.g., daily, weekly, monthly).
  • recurrenceInterval (required) — For recurring charges only, set the interval between recurrences (e.g., 2 means every 2 recurrence periods).
  • recurrenceStartDate (required) — For recurring charges only, specify the start date for the first recurrence; this date cannot be in the past.
  • endSubscription — For recurring charges only, define how the recurrence ends: no end date, a specific end date, or a maximum number of payments.
  • endSubscriptionDate — If endSubscription is set to 'Choose End Date', specify the date when recurrence ends.
  • maxPayments — If endSubscription is 'Choose Number of Payments', specify the maximum number of payments before the recurrence ends.
  • additionalFields — Optional fields including currency (default BRL), delivery amount, discounts, interest, fines, notification channels, fee payment settings, payment anticipation request, and creation of payment dunning schedule.

Output shape

a single record per input item containing the JSON response from Adapay representing the created charge or errors if any occur.

Returns one output item per input item processed. Includes error details per item if 'Continue On Fail' is enabled.

Examples

Example 1: Create a unique one-time charge with one product and one customer, using boleto payment method, due tomorrow.

Set Charge Type to UNIQUE, add one item referencing a product ID, add one client with customer ID, select billing type Boleto Bancário, specify due date and single installment.

Example 2: Create a monthly recurring charge with multiple installments, multiple clients, and credit card payment allowed.

Set Charge Type to RECURRENCE, specify recurrence frequency as monthly and interval as 1, set recurrence start date and optional end subscription parameters, add multiple items and clients, select billing types including credit card.

Links

Discussion