Actions116
- Course Actions
- Bundle Actions
- Course Grade Actions
- Course Grade Detail Actions
- Course Teacher Actions
- Email Actions
- Email Campaign Actions
- Email Campaign Course Actions
- Email Campaign Excluded Course Actions
- Email Campaign Excluded List Actions
- Email Campaign Excluded Plan Actions
- Email Campaign List Actions
- Email Campaign Plan Actions
- Email List Actions
- Enroll Actions
- MindzPay Account Actions
- MindzPay Invoice Actions
- MindzPay Payment Actions
- MindzPay Subscription Actions
- Subscription Actions
- Team Actions
- User Actions
Overview
The MindzPay Invoice "Get" operation node allows users to retrieve detailed information about a specific invoice from the MindzPay system. This is useful in scenarios where you need to fetch the current status, details, or metadata of an invoice for processing, auditing, or display purposes.
Practical examples include:
- Fetching invoice details to verify payment status before granting access to a service.
- Retrieving invoice data to generate reports or send reminders.
- Integrating with other systems that require up-to-date invoice information.
Properties
| Name | Meaning |
|---|---|
| Account Key | The key identifying the MindzPay account associated with the invoice. |
| Invoice ID | The unique identifier of the invoice to retrieve. |
Output
The node outputs JSON data representing the full details of the requested invoice. This typically includes fields such as invoice amount, status, issue date, due date, payer information, and any other metadata provided by the MindzPay API related to that invoice.
If the node supports binary data output (not indicated here), it would represent attachments or invoice documents, but this is not evident from the provided code.
Dependencies
- Requires an active connection to the Mindz API authenticated via an OAuth2-based credential (an API authentication token).
- The node depends on the MindzPay API being accessible and the provided Account Key and Invoice ID being valid.
- No additional external dependencies are indicated.
Troubleshooting
Common Issues:
- Invalid or missing Account Key or Invoice ID will cause the request to fail.
- Network connectivity issues can prevent successful API calls.
- Expired or invalid OAuth2 credentials will result in authentication errors.
Error Messages:
- "Unauthorized" or "Authentication failed": Check that the API authentication token is valid and has not expired.
- "Invoice not found": Verify that the Invoice ID is correct and exists under the specified Account Key.
- "Invalid parameters": Ensure all required properties are provided and correctly formatted.
Resolving these usually involves verifying input parameters, refreshing credentials, and ensuring network connectivity.
Links and References
- MindzPay API Documentation (general reference for invoice endpoints)
- OAuth2 Authentication setup guides for Mindz API integration