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 to manage refunds related to payments. Specifically, the "Refund" resource with the "Create" operation allows users to create a refund for a specific payment by specifying the payment ID and the amount to be refunded. This is useful in scenarios where a customer needs to be reimbursed partially or fully for a payment they made.
Practical examples include:
- Refunding a customer who returned a product.
- Issuing partial refunds for services not rendered.
- Automating refund processes within an e-commerce workflow.
Properties
| Name | Meaning |
|---|---|
| Payment ID | The unique identifier of the payment for which the refund is being created. |
| Amount | The monetary amount to refund for the specified payment. |
| Notes | Optional text notes or comments about the refund (e.g., reason for refund). |
Output
The node outputs a JSON array containing the response from the Partially API after creating the refund. This typically includes details about the newly created refund such as its ID, associated payment ID, refunded amount, status, timestamps, and any notes provided.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the Partially Payment Plans API.
- Needs an API authentication token or API key credential configured in n8n to authorize requests.
- The node uses internal helper functions to make HTTP requests to the Partially API endpoints.
Troubleshooting
Common issues:
- Invalid or missing Payment ID: Ensure the payment ID exists and is correctly entered.
- Amount exceeds original payment: The refund amount should not exceed the original payment amount.
- Authentication errors: Verify that the API key or token is valid and has sufficient permissions.
- Network or connectivity problems: Check internet access and API endpoint availability.
Error messages:
- "Unauthorized" or "Authentication failed": Indicates invalid or missing API credentials.
- "Payment not found": The specified payment ID does not exist.
- "Invalid amount": The refund amount is zero, negative, or exceeds allowed limits.
Resolving these usually involves verifying input parameters, checking API credentials, and ensuring the payment exists in the system.
Links and References
- Partially API Documentation (replace with actual URL)
- n8n documentation on creating custom nodes