Partially

Overview

This node integrates with the Partially Payment Plans API to manage payments and related entities. Specifically, the Payment - Confirm operation finalizes a payment by confirming it with required details such as the payment plan ID, amount, and customer contract signature. This is typically used after initiating a payment that requires confirmation, for example, after a 3D Secure authentication step or when a customer has signed a contract digitally.

Common scenarios include:

• Confirming a payment after a customer has completed necessary authentication.
• Finalizing scheduled payments within a payment plan.
• Ensuring compliance by attaching a customer's contract signature to the payment confirmation.

Practical example: After creating a payment plan and initiating a payment, you use this node to confirm the payment by providing the payment plan ID, the amount to be charged, and the customer's digital signature on the contract. Optionally, you can specify a return URL to redirect the user after any additional authentication steps.

Properties

Output

The node outputs an array of JSON objects representing the confirmed payment(s). Each object contains detailed information about the payment confirmation response from the Partially API, including status, identifiers, amounts, and any metadata returned by the API.

If the payment involves binary data (e.g., documents or signatures), it would be included in the output accordingly, but based on the static code analysis, this node primarily returns JSON data related to payment confirmation.

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.
• The node uses internal helper functions to make HTTP requests to the API endpoints.

Troubleshooting

• Missing Required Fields: Ensure that Payment Plan ID, Amount, and Contract Signature are provided; otherwise, the API will reject the request.
• Invalid Contract Signature: If the signature format is incorrect or missing, the confirmation may fail.
• API Authentication Errors: Verify that the API key/token credential is correctly set up and has sufficient permissions.
• Return URL Issues: If using the Return URL, ensure it is a valid URL; invalid URLs might cause redirection failures.
• Network or API Downtime: Temporary connectivity issues or API outages can cause errors; retry after some time or check API status.

Common error messages usually come directly from the API and relate to validation errors, authentication failures, or resource not found errors. Review the error message details and verify input parameters accordingly.

Links and References

• Partially Payment Plans API Documentation (example placeholder link)
• 3D Secure Authentication Overview
• Digital Signature Standards

Note: The above summary is based solely on static analysis of the provided source code and property definitions.