Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to manage various payment-related resources. Specifically, for the Payment resource with the List operation, it retrieves a list of payments filtered by multiple criteria such as customer ID, payment plan ID, Stripe payment intent ID, status, currency, and date ranges.

Common scenarios where this node is beneficial include:

  • Fetching all payments made by a specific customer.
  • Retrieving payments associated with a particular payment plan.
  • Filtering payments by their status (e.g., paid, pending, failed).
  • Analyzing payments within a certain date range or currency.
  • Integrating payment data into workflows for reporting, reconciliation, or triggering downstream processes.

Practical example:

  • A business wants to generate a report of all successful payments in USD made last month for a given payment plan. Using this node, they can specify the payment plan ID, set the currency filter to USD, and define the date range to cover last month, retrieving the relevant payments efficiently.

Properties

Name Meaning
Customer ID Filter payments by the unique identifier of the customer who made them.
Payment Plan ID Filter payments linked to a specific payment plan.
Stripe Payment Intent ID Filter payments by the Stripe payment intent identifier.
Additional Filters Collection of optional filters including:
- Created Date Range Maximum (date_max) Upper bound of the creation date range to filter payments.
- Created Date Range Minimum (date_min) Lower bound of the creation date range to filter payments.
- Currency Filter payments by currency code (e.g., USD, EUR).
- Limit (per_page) Number of payments to retrieve per request (minimum 1, maximum 100).
- Payment Created Date (date) Filter payments created on a specific date.
- Payment Status (status) Filter payments by status; options are: Failed, Paid, Pending.

Output

The node outputs an array of payment objects in the json field. Each object represents a payment record retrieved from the Partially API, containing details such as payment identifiers, amounts, statuses, dates, and related metadata.

If binary data were involved (not indicated here), it would typically represent files or attachments related to payments, but this node focuses on JSON payment data only.

Dependencies

  • Requires an active connection to the Partially Payment Plans API.
  • Needs an API authentication token or API key credential configured in n8n to authorize requests.
  • The node uses internal helper functions to make HTTP requests to the Partially API endpoints.

Troubleshooting

  • Empty results: If no payments are returned, verify that the filter parameters (customer ID, payment plan ID, dates, etc.) are correct and that payments exist matching those criteria.
  • Invalid date formats: Ensure date inputs follow ISO 8601 format or are correctly parsed by the node; incorrect formats may cause errors or empty responses.
  • API authentication errors: Confirm that the API key or token is valid and has sufficient permissions to access payment data.
  • Rate limiting or network issues: If requests fail intermittently, check network connectivity and API rate limits imposed by the Partially service.
  • Parameter conflicts: Avoid specifying conflicting filters (e.g., both a single date and a date range) which might lead to unexpected results.

Links and References

Discussion