Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to manage refunds among other resources. Specifically, the Refund - List operation retrieves a list of refund records filtered by various criteria such as customer ID, reason for refund, and date ranges.

Common scenarios where this node is beneficial include:

  • Retrieving all refunds issued to a specific customer.
  • Filtering refunds by reason (e.g., requested by customer, fraudulent, duplicate).
  • Fetching refunds within a particular date or date range for reporting or reconciliation purposes.

Practical example:

  • A finance team wants to generate a report of all refunds requested by customers in the last month. They can use this node to list refunds filtered by the "Requested by Customer" reason and a date range covering the previous month.

Properties

Name Meaning
Customer ID The unique identifier of the customer whose refunds you want to list.
Additional Filters Optional filters to narrow down the refund list:
  Reason Filter refunds by reason. Options: Requested by Customer, Fraudulent, Duplicate.
  Date Filter refunds by a specific date.
  Date Range Minimum Start date of the date range filter.
  Date Range Maximum End date of the date range filter.

Output

The output is an array of JSON objects representing refund records matching the specified filters. Each refund object typically includes details such as:

  • Refund ID
  • Associated payment ID
  • Amount refunded
  • Reason for refund
  • Date of refund
  • Notes (if any)
  • Customer ID linked to the refund

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • Empty results: If no refunds are returned, verify that the Customer ID and filters are correct and that refunds exist for those parameters.
  • Invalid date format errors: Ensure dates are provided in ISO 8601 format or compatible formats accepted by the node.
  • Authentication errors: Confirm that the API key credential is valid and has sufficient permissions.
  • API request failures: Network issues or API downtime may cause errors; check connectivity and API status.
  • Incorrect filter usage: Using mutually exclusive or unsupported filter combinations might result in errors or empty responses.

Links and References

Discussion