Mindz icon

Mindz

Interact with Mindz API

Actions116

Overview

The MindzPay Invoice Cancel operation allows users to cancel an existing invoice within the MindzPay system. This is useful in scenarios where an invoice was issued incorrectly, needs to be voided due to changes in order or subscription status, or when a payment should no longer be collected.

Practical examples include:

  • Canceling an invoice that was created by mistake before payment is processed.
  • Voiding an invoice for a customer who has requested cancellation of their order.
  • Managing subscription billing by canceling invoices related to canceled subscriptions.

Properties

Name Meaning
Account Key The key of the MindzPay account used to authenticate and identify the account context.
Invoice ID The unique identifier of the invoice to be canceled.

Output

The node outputs JSON data representing the result of the cancel operation on the specified invoice. This typically includes confirmation details such as the invoice ID, status after cancellation, timestamps, and any relevant metadata returned by the MindzPay API.

If the node supports binary data output (not indicated here), it would represent associated files or documents related to the invoice cancellation, but this is not applicable based on the provided code and properties.

Dependencies

  • Requires an API authentication token credential configured in n8n to access the Mindz API.
  • Depends on the MindzPay API service being available and accessible.
  • The node uses internal resource modules corresponding to MindzPay Invoice operations.

Troubleshooting

  • Common issues:

    • Invalid or missing Account Key or Invoice ID will cause the operation to fail.
    • Network connectivity problems or API downtime can prevent successful cancellation.
    • Insufficient permissions or invalid credentials may lead to authorization errors.
  • Error messages:

    • Errors indicating "Invoice not found" suggest the Invoice ID does not exist or is incorrect.
    • Authentication errors imply issues with the provided API key or token.
    • Validation errors may occur if required parameters are missing or malformed.
  • Resolutions:

    • Verify the Account Key and Invoice ID values are correct and correspond to existing resources.
    • Ensure the API credentials are valid and have necessary permissions.
    • Check network connectivity and MindzPay API status.
    • Review error messages for specific guidance and adjust input parameters accordingly.

Links and References

  • MindzPay official API documentation (refer to the invoice management section).
  • n8n documentation on creating and using custom nodes with API credentials.
  • General REST API troubleshooting guides for authentication and request validation.

Discussion