Partially icon

Partially

Partially Payment Plans API
Join our community

Actions37

Overview

The node integrates with the Partially Payment Plans API, enabling automation of various payment plan-related operations. Specifically, for the Payment Plan resource and the Send Plan Request operation, it sends a request to notify or trigger an action related to an existing payment plan.

This operation is useful in scenarios where you want to programmatically prompt the system or customer about a payment plan, such as sending reminders, notifications, or initiating further processing steps. For example, after creating a payment plan, you might want to send a plan request to the customer to confirm or activate the plan.

Properties

Name Meaning
Update Plan Status to Pending Boolean option to update the payment plan's status to "pending" when sending the request.

Output

  • The output is a JSON array containing the response from the Partially API after sending the plan request.
  • The structure of the JSON corresponds to the updated or returned payment plan object as provided by the API.
  • No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Partially Payment Plans API.
  • The node uses the internal helper function partiallyApiRequest to make HTTP requests to the Partially API endpoints.
  • Proper configuration of the API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing payment plan ID will cause the API call to fail.
    • Insufficient permissions or invalid API key may result in authentication errors.
    • Network connectivity problems can prevent the request from reaching the API.

  • Error messages:

    • Errors related to "payment_plan_id" not found or invalid indicate that the specified payment plan does not exist.
    • Authentication errors suggest checking the API key credential setup.
    • Validation errors may occur if the optional flag to update the plan status is set incorrectly or conflicts with the current plan state.

  • Resolutions:

    • Verify the payment plan ID is correct and exists in the Partially system.
    • Ensure the API key credential is valid and has required permissions.
    • Check network connectivity and retry the operation.
    • Review the boolean property "Update Plan Status to Pending" usage according to your workflow needs.

Links and References

Discussion