Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

The node integrates with the Partially Payment Plans API to manage offers, specifically allowing users to create new offers. An offer represents a payment plan configuration that can include details such as currency, down payment options, payment schedule, and installment terms.

This node operation is beneficial for businesses that want to automate the creation of flexible payment plans or offers for their customers. For example, an e-commerce platform could use this node to generate customized payment offers with specific down payments, payment frequencies, and term lengths, enabling customers to pay in installments.

Properties

Name Meaning
Name The name of the offer.
Currency Default currency to use for payment plans if not specified. Example: "USD".
Automatically Schedule Installments Whether to automatically schedule installments according to the provided schedule (true/false).
Payment Schedule Description A description of when payments will be processed. Only shown if automatic scheduling is disabled.
Down Payment Type Type of down payment: either "Percentage of Plan Amount" or "Fixed Amount".
Down Payment Amount/percentage The amount or percentage value of the down payment.
Down Payment Flexible Whether the customer can choose their down payment within a specified range (true/false).
Minimum Down Payment Amount/percentage Minimum allowed down payment if flexibility is enabled.
Maximum Down Payment Amount/percentage Maximum allowed down payment if flexibility is enabled.
Term Units Units for the term length: "Date", "Fixed Number of Payments", "Months", "Weeks", or "Years".
Term Value The number of weeks, months, years, or payments for the term. Required unless Term Units is "Date".
Final Payment Date The date of the final payment. Used only if Term Units is "Date". Time portion is ignored.
Term Flexible Whether the customer can choose their payment frequency within a specified range (true/false).
Minimum Term Minimum term length allowed if flexibility is enabled.
Maximum Term Maximum term length allowed if flexibility is enabled.
Frequency Units Units for payment frequency: "Days", "Weeks", "Months", or "Specific Days of the Month".
Frequency Value Number of days, weeks, or months between payments. Used unless Frequency Units is "Specific Days of the Month".
Days of the Month Comma-separated list of days of the month to process payments. Used only if Frequency Units is "Specific Days of the Month".
Frequency Flexible Whether the customer can choose their payment frequency within a specified range (true/false).
Minimum Frequency Minimum frequency allowed if flexibility is enabled.
Maximum Frequency Maximum frequency allowed if flexibility is enabled.
Automatically Schedule First Installment Whether to automatically schedule the first installment relative to the plan opened date (true/false).
Date of First Installment The date of the first installment. Used only if automatic scheduling of the first installment is disabled. Time portion is ignored.

Output

The output is a JSON array containing the response from the Partially API after creating the offer. This typically includes the full details of the newly created offer object, such as its ID, name, currency, payment schedule, down payment settings, term details, and other metadata.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Partially Payment Plans API.
  • The node uses internal helper functions to make HTTP requests to the Partially API endpoints.
  • No additional external dependencies are indicated.

Troubleshooting

  • Missing required fields: The "Name" and "Currency" fields are mandatory. Omitting these will likely cause API errors.
  • Invalid date formats: Dates must be valid ISO date strings; otherwise, the API may reject the request.
  • Inconsistent flexible ranges: If flexibility is enabled for down payment, term, or frequency, ensure minimum values are less than maximum values.
  • API authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Unexpected API errors: Check the logs for detailed error messages returned by the API and verify all parameters conform to expected types and constraints.

Links and References

Discussion