Bizappay icon

Bizappay

Interact with Bizappay API

Actions13

Overview

This node integrates with the Bizappay API to create a new bill (invoice) for customers. It allows users to specify detailed billing information such as the bill name, amount, category, and payer details including name, email, and phone number. The node supports using predefined templates to simplify common billing scenarios like simple payments, e-commerce orders, or subscription/recurring payments.

Typical use cases include:

  • Generating invoices for products or services.
  • Creating payment requests for customers with specific categories and references.
  • Automating billing workflows in Malaysian Ringgit currency.
  • Using templates to quickly set up standard payment types with appropriate fields.

For example, an online store can create an e-commerce order bill with callback URLs for payment notifications, or a subscription service can generate recurring payment bills with external reference tracking.

Properties

Name Meaning
Bill Name The title or name of the bill/invoice.
Amount (RM) The total amount of the bill in Malaysian Ringgit. Must be between RM 0.01 and RM 999,999.99.
Category Name or ID The category under which this bill falls. Users can select from existing categories loaded dynamically or specify an ID via expression.
Payer Name The name of the customer or payer responsible for the bill.
Payer Email The email address of the payer. Must be a valid email format.
Payer Phone The phone number of the payer in Malaysian format (e.g., 0123456789 or +60123456789).
Use Template Select a template to pre-fill common settings:
- None (Custom): No template, fully custom fields.
- Simple Payment: Basic payment with minimal fields.
- E-Commerce Order: Includes callback and return URLs.
- Subscription/Recurring: Includes external reference tracking.
Additional Fields Optional extra fields to add more details:
- Description: Text description of the bill.
- Due Date: When the bill is due.
- External Reference: External ID for cross-referencing.
- Web Return URL: Redirect URL after payment.
- Callback URL: Webhook URL for payment notifications.
- Bank Name or ID: Specific bank code to bypass payment page.
- Quantity: Number of items for calculation.
- Fixed Amount: Whether the amount is fixed (true) or open for customer input (false).

Output

The node outputs JSON data representing the created bill and related metadata:

  • billId: Unique identifier of the created bill.
  • billUrl: URL where the customer can make the payment.
  • Other bill details as returned by the API.
  • _quickActions: Helpful next steps such as sending the payment URL to the customer and monitoring payment status.
  • _nextSteps: Suggested actions post-creation.

If the bill creation is successful, these fields help automate follow-up processes like notification and tracking.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Bizappay API with proper authentication credentials (an API key or token).
  • The node uses internal helper functions to make authenticated POST requests to Bizappay endpoints.
  • Dynamic loading of categories and banks depends on API availability.
  • Environment must support HTTPS requests to Bizappay endpoints.

Troubleshooting

  • Invalid Input Errors:
    • Amount must be greater than zero and within allowed range.
    • Payer email must match a valid email regex pattern.
    • Payer phone must conform to Malaysian phone number format.
  • API Request Failures:
    • Network issues or invalid API credentials will cause request failures.
    • Ensure the API key/token is correctly configured in n8n credentials.
  • Category or Bank Not Found:
    • If specified category or bank code does not exist, the API may reject the request.
    • Use the dynamic dropdowns to select valid options or verify IDs.
  • Template Misconfiguration:
    • Selecting a template auto-fills some fields; overriding them incorrectly may cause unexpected results.
  • Error Messages:
    • "Bill ID is required for update/delete operations" indicates missing mandatory parameters.
    • Validation errors for email or phone provide clear messages to correct input.
  • To resolve most issues, verify all required fields are correctly filled and credentials are valid.

Links and References

Discussion