Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API, enabling automation of various payment-related operations. Specifically, for the Installment resource and the Pay operation, it allows users to trigger a payment action on a specific installment by its ID. This is useful in scenarios where you want to programmatically initiate payment collection for an installment within a payment schedule or plan.

Practical examples include:

  • Automatically paying an installment when triggered by an event (e.g., after an invoice is generated).
  • Integrating installment payments into broader workflows such as CRM updates or notification systems.
  • Managing installment payments without manual intervention, improving cash flow management.

Properties

Name Meaning
Installment ID The unique identifier of the installment to be paid. This is required to specify which installment to pay.
Return URL An optional URL to which the user or system will be redirected after the payment process completes.

Output

The node outputs a JSON array containing the response from the Partially API after attempting to pay the specified installment. The structure of the JSON output corresponds to the API's response for the installment payment endpoint, typically including details about the payment status, installment information, and any relevant metadata.

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Installment ID will likely result in an error from the API indicating that the installment could not be found.
    • Missing or incorrect API credentials will cause authentication failures.
    • Network connectivity problems can prevent successful API calls.

  • Error messages and resolutions:

    • "Unauthorized" or "Authentication failed": Verify that the API key or token is correctly set up in n8n credentials.
    • "Installment not found": Check that the Installment ID is correct and exists in the Partially system.
    • "Invalid return URL": Ensure the Return URL, if provided, is a valid URL format accepted by the API.

Links and References

Discussion