Bizappay icon

Bizappay

Interact with Bizappay API

Actions2

Overview

This node integrates with the Bizappay API to create new bills (invoices) for customers. It is useful in scenarios where you want to automate billing processes, such as generating payment requests for products or services and sending them to customers via email or phone. The node supports specifying detailed customer information and bill metadata, allowing businesses to track payments efficiently.

Practical examples include:

  • Creating a bill for an online purchase with product details and customer contact info.
  • Automating invoice generation for subscription services.
  • Sending payment requests with callback URLs to handle payment status updates.

Properties

Name Meaning
Amount The total amount of the bill. Must be a positive number.
Product Name Description of the product or service being billed. Minimum 5 characters, max 255 characters.
Category Bill category selected from dynamically loaded options representing different billing categories.
Customer Name Full name of the customer. Between 5 and 70 characters.
Customer Email Customer's email address. Maximum 50 characters; must be a valid email format.
Customer Phone Customer's phone number. Maximum 20 characters.
Advanced Options Optional collection including:
- Web Return URL URL to redirect the user after payment completion (optional).
- Callback URL URL to receive payment status callbacks (optional).
External Reference Optional external reference number for your own system (e.g., invoice number).

Output

The node outputs JSON data representing the response from the Bizappay API after creating a bill. This typically includes details about the created bill such as its unique identifier, status, and any relevant URLs for payment processing.

If multiple items are processed, the output will be an array of such JSON objects.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Bizappay API.
  • The node uses HTTP POST requests to interact with endpoints like /bill/create and /category.
  • Optionally, environment variable SYSTEM_HEALTH_CHECK can be set to specify a webhook URL for health check or logging purposes (defaults to a preset URL if not set).

Troubleshooting

  • Invalid or missing required fields: Ensure all required properties (amount, description, category, customer name/email/phone) are provided and meet validation criteria (e.g., minimum lengths, valid email format).
  • API authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
  • Network or timeout issues: The node makes HTTP requests with a timeout; ensure network connectivity and that the Bizappay API endpoint is reachable.
  • Error messages from API: The node surfaces error messages returned by the API. Common errors may relate to invalid parameters or server-side issues.
  • Input data formatting: If input data is empty or malformed, the node defaults some values (e.g., default product name, default customer name/email/phone) to prevent failures but review inputs to avoid unintended defaults.

Links and References

Discussion