Actions13
- Category Actions
- Payment Bank Actions
- Bill Actions
- Payment Status Actions
- Webhook Actions
Overview
This node integrates with the Bizappay API to manage billing operations. Specifically, the Bill - Update operation allows users to update details of an existing bill in the Bizappay system. This is useful for scenarios where bill information such as amount, payer details, due date, or description needs to be modified after creation.
Practical examples include:
- Correcting a bill amount if there was an error.
- Updating the payer's contact information.
- Changing the due date to extend payment terms.
- Adding or modifying callback URLs for payment notifications.
This operation helps keep billing data accurate and up-to-date, ensuring smooth payment processing and communication with customers.
Properties
| Name | Meaning |
|---|---|
| Bill ID | The unique identifier of the bill to update (required). |
| Update Fields | A collection of fields to update on the bill. Options include: |
| - Bill Name: Updated name/title of the bill. | |
| - Amount (RM): Updated bill amount in Malaysian Ringgit (must be > 0). | |
| - Category Name or ID: Updated category for the bill, selectable from existing categories. | |
| - Payer Name: Updated customer/payer name. | |
| - Payer Email: Updated customer/payer email address (validated for proper email format). | |
| - Payer Phone: Updated customer/payer phone number (validated for Malaysian phone format). | |
| - Description: Updated description of the bill. | |
| - Due Date: Updated due date for the bill payment. | |
| - External Reference: Updated external reference ID for integration purposes. | |
| - Web Return URL: Updated URL to redirect the user after payment completion. | |
| - Callback URL: Updated webhook URL for receiving payment notifications. |
Output
The output JSON object contains the response from the Bizappay API after attempting to update the bill. It typically includes:
- Confirmation of the update status.
- Updated bill details reflecting the changes.
- Metadata such as timestamps and success indicators.
If the update is successful, the output confirms the changes; otherwise, it provides error messages explaining what went wrong.
No binary data is output by this operation.
Dependencies
- Requires an active connection to the Bizappay API via an API key credential configured in n8n.
- The node uses internal helper functions to make authenticated HTTP POST requests to Bizappay endpoints.
- The "Category Name or ID" field options are dynamically loaded from the Bizappay categories endpoint.
- Proper validation of email and Malaysian phone number formats is enforced before sending updates.
Troubleshooting
- Missing Bill ID: The operation requires a valid Bill ID. If omitted, the node throws an error indicating that the Bill ID is required.
- Invalid Amount: Amount must be greater than zero. Providing zero or negative values results in an error.
- Email Format Error: The payer email must match a standard email regex pattern. Invalid emails cause validation errors.
- Phone Number Format Error: The payer phone must conform to Malaysian phone number formats. Incorrect formats trigger validation errors.
- API Errors: Network issues or invalid credentials will result in API request failures. Check API key validity and network connectivity.
- Category Not Found: If an invalid category ID is provided, the update may fail. Use the dynamic category selector to avoid this.
To resolve these issues, ensure all required fields are correctly filled, validate inputs before execution, and verify API credentials and network access.
Links and References
- Bizappay API Documentation (hypothetical link for reference)
- n8n Expressions Documentation
- Malaysian Phone Number Format Reference
- Email Validation Regex Explanation