Actions37
- Offer Item Actions
- Customer Actions
- Dispute Actions
- Installment Actions
- Line Item Actions
- Offer Actions
- Payment Actions
- Payment Method Actions
- Payment Plan Actions
- Payment Schedule Actions
- Refund Actions
Overview
This node integrates with the Partially Payment Plans API, enabling users to manage payment plans and related entities such as customers, offers, payments, refunds, disputes, and more. Specifically, for the Payment Plan - Open operation, it allows opening an existing payment plan by providing necessary authorization details like the customer's contract signature and payment method. This is useful in scenarios where a payment plan has been created but requires activation or authorization before it can be used for processing payments.
Practical examples include:
- Activating a payment plan after collecting the customer's digital signature and payment method.
- Redirecting the customer to a 3D Secure authentication page during payment method authorization.
- Automating the workflow of managing payment plans within e-commerce or subscription platforms.
Properties
| Name | Meaning |
|---|---|
| Payment Plan ID | The unique identifier of the payment plan to open. |
| Customer Contract Signature | The customer's digital signature confirming their agreement to the contract. |
| Payment Method ID | The identifier of the payment method to associate with the payment plan. |
| Authorization Return URL | (Optional) URL to redirect the user to after completing 3D Secure authentication. |
Output
The node outputs a JSON object representing the updated payment plan after it has been opened. This typically includes details such as the payment plan's status, associated customer information, payment schedule, and any relevant metadata returned by the Partially API.
If the operation involves redirection for 3D Secure authentication, the output may also contain URLs or tokens needed to complete the authorization process.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the Partially Payment Plans API.
- Needs an API key or token credential configured in n8n to authenticate requests to the Partially API.
- Proper configuration of the node’s credentials section with valid API access is mandatory.
Troubleshooting
- Missing Required Fields: Ensure that
Payment Plan ID,Customer Contract Signature, andPayment Method IDare provided; otherwise, the API request will fail. - Invalid Payment Plan ID: If the payment plan ID does not exist or is incorrect, the API will return an error indicating the resource was not found.
- Authorization Failures: Incorrect or invalid contract signatures or payment method IDs may cause authorization errors.
- 3D Secure Redirect Issues: If the
Authorization Return URLis not correctly set or accessible, the user might not be redirected properly after authentication. - API Connectivity: Network issues or invalid API credentials will prevent successful communication with the Partially API.
To resolve these issues:
- Double-check all required input parameters.
- Verify API credentials and network connectivity.
- Confirm that the payment plan exists and is in a state that can be opened.
- Ensure the return URL is a valid, reachable endpoint.
Links and References
- Partially API Documentation (general reference for API endpoints and usage)
- 3D Secure Authentication Overview (for understanding the authentication flow)
Note: The above summary is based on static analysis of the node's source code and provided property definitions without runtime execution.