Bizappay icon

Bizappay

Interact with Bizappay API

Actions13

Overview

This node integrates with the Bizappay API to manage categories, bills, payment banks, payment statuses, webhooks, and monitoring metrics. Specifically for the Category - Create operation, it allows users to create a new category that can be used to organize bills within the Bizappay system.

Common scenarios where this node is beneficial include:

  • Automating the creation of billing categories in financial or invoicing workflows.
  • Organizing bills by categories such as utilities, subscriptions, or services.
  • Integrating category management into larger automated payment or accounting processes.

For example, a business could use this node to automatically create a "Utilities" category before generating bills related to electricity and water payments.

Properties

Name Meaning
Name The name of the category to create.
Description A brief description of the category (maximum 50 characters).

Output

The output JSON object for the Category Create operation includes:

  • categoryCode: The unique code or ID assigned to the newly created category.
  • _quickActions (metadata): Contains quick action hints such as the category code and a success message indicating the category was created successfully and can now be used for bills.

Example output snippet:

{
  "categoryCode": "CAT123",
  "_quickActions": {
    "categoryCode": "CAT123",
    "message": "Category created successfully. You can now use this code for bills."
  }
}

Dependencies

  • Requires an active connection to the Bizappay API via an API key credential configured in n8n.
  • Uses the internal helper function to make authenticated POST requests to Bizappay endpoints.
  • No additional external dependencies beyond the Bizappay API and standard Node.js crypto module (used for webhook signature verification in other operations).

Troubleshooting

  • API Request Failures: If the API request to create a category fails, ensure the API key credential is valid and has sufficient permissions.
  • Validation Errors: The node requires both "Name" and "Description" fields; missing or invalid inputs will cause errors.
  • Description Length: The description should not exceed 50 characters; longer descriptions may be rejected by the API.
  • Network Issues: Connectivity problems with the Bizappay API endpoint will result in errors; verify network access.
  • Unexpected Response: If the response does not contain a categoryCode, the node will not confirm successful creation; check API status or logs.

Links and References


This summary focuses on the Category resource's Create operation as requested. Other resources and operations are supported but not detailed here.

Discussion