Bizappay icon

Bizappay

Interact with Bizappay API

Actions2

Overview

This node interacts with the Bizappay API to retrieve detailed information about a specific bill using its unique bill code. It is particularly useful in scenarios where you need to verify the status or details of a payment or invoice programmatically within an automation workflow.

Practical examples include:

  • Automatically checking the payment status of a bill after a customer completes a transaction.
  • Retrieving bill details for reconciliation or reporting purposes.
  • Filtering bills by their payment status to trigger different workflow branches (e.g., send reminders for pending payments).

Properties

Name Meaning
Bill Code The unique identifier code of the bill to search for. This is required to fetch the bill info.
Payment Status Filter for the payment status of the bill. Options: Success, Pending, Failed, No Action/Not Paid

Output

The node outputs JSON data representing the bill information retrieved from the Bizappay API. The structure typically includes details such as bill amount, payer information, payment status, and other metadata related to the bill.

If multiple results are returned, they are output as an array of JSON objects. Otherwise, a single JSON object is returned.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Bizappay API.
  • The node uses HTTP POST requests to communicate with the Bizappay endpoints.
  • Environment variable SYSTEM_HEALTH_CHECK may be used internally for health check webhook calls but is not mandatory for basic operation.

Troubleshooting

  • Missing Bill Code: If the "Bill Code" property is empty or missing, the node will throw an error stating "Bill code is required". Ensure that this field is correctly set.
  • Invalid Payment Status: Using an unsupported payment status value may result in no matching bills found or unexpected results.
  • API Errors: Network issues, invalid API keys, or Bizappay service downtime can cause errors. Check your API credentials and network connectivity.
  • Malformed Input: Ensure that the input data to the node is properly formatted and contains the required fields.
  • Continue on Fail: If enabled, the node will output error details in the JSON output instead of stopping execution, which can help in debugging workflows.

Links and References

Discussion