Mindz icon

Mindz

Interact with Mindz API

Actions115

Overview

The MindzPay Invoice node's Refresh operation is designed to update or refresh the status and details of a specific invoice within the MindzPay system. This operation is useful when you want to ensure that your workflow has the most current information about an invoice, such as its payment status or any changes made externally.

Typical use cases include:

  • Automatically updating invoice records in your database after external payment processing.
  • Triggering follow-up actions based on the latest invoice status.
  • Synchronizing invoice data between MindzPay and other systems.

For example, after sending an invoice to a customer, you might periodically refresh the invoice status to check if it has been paid or canceled.

Properties

Name Meaning
Account Key The key identifying the MindzPay account associated with the invoice.
Invoice ID The unique identifier of the invoice to be refreshed (retrieved, updated, reissued, or canceled).

Output

The node outputs JSON data representing the refreshed invoice details. This typically includes updated fields such as invoice status, payment information, dates, amounts, and any other relevant metadata returned by the MindzPay API for the specified invoice.

If the node supports binary data output (not indicated here), it would represent attachments or documents related to the invoice, but this is not evident from the provided code.

Dependencies

  • Requires an active connection to the Mindz API via an OAuth2-based authentication credential (an API key or token).
  • The node depends on the MindzPay API being accessible and the provided Account Key and Invoice ID being valid.
  • No additional environment variables or external services are explicitly required beyond the configured Mindz API credentials.

Troubleshooting

  • Invalid Account Key or Invoice ID: If these inputs are incorrect or missing, the API call will fail. Ensure both are correctly set.
  • Authentication Errors: If the OAuth2 credential is expired or invalid, the node will throw authentication errors. Refresh or reconfigure the credential.
  • API Connectivity Issues: Network problems or Mindz API downtime can cause failures. Verify network access and Mindz service status.
  • Permission Denied: The account key used may lack permissions to access or refresh the specified invoice.
  • Unexpected Response Format: If the Mindz API changes, the node might not parse responses correctly, requiring updates to the node implementation.

Links and References

Discussion