Overview
This node integrates with the Billplz payment gateway API to create a new bill within a specified collection. It is useful for automating billing processes, such as generating payment requests for customers via email or mobile. Typical scenarios include e-commerce platforms issuing bills for orders, subscription services requesting payments, or any system needing to programmatically generate and manage payment bills.
For example, you can use this node to create a bill for a customer by specifying their email, name, amount due, and description of the bill. Additional options allow setting due dates, callback URLs for payment notifications, and redirect URLs after payment completion.
Properties
| Name | Meaning |
|---|---|
| Collection ID | The identifier of the collection where the bill will be created. |
| Customer's email address to send the bill notification. | |
| Mobile | (Optional) Customer's mobile phone number. |
| Name | Customer's full name. |
| Amount (in cents) | The total amount of the bill in cents (e.g., 200 means RM 2.00). |
| Description | A detailed description of the bill or what it is for. |
| Additional Fields | Optional extra settings including: |
| - Callback URL | URL to receive payment notification callbacks from Billplz. |
| - Redirect URL | URL to redirect the customer after payment completion. |
| - Due Date | The date and time when the bill is due. |
| - Reference 1 Label | Custom label for the first reference field. |
| - Reference 1 | Value for the first reference field. |
| - Reference 2 Label | Custom label for the second reference field. |
| - Reference 2 | Value for the second reference field. |
Output
The node outputs a JSON array containing the response data from the Billplz API after creating the bill. This typically includes details such as the bill ID, status, payment URL, and other metadata returned by the API.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the Billplz payment gateway.
- The node uses the Billplz REST API endpoint at
https://www.billplz.com/api. - The "Collection ID" property depends on dynamically loaded collections from the Billplz account, so the node must have permission to list collections.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing an incorrect or non-existent Collection ID will result in errors from the API.
- Required fields like email, name, amount, and description must be provided; otherwise, the API may reject the request.
- Network connectivity problems can prevent communication with the Billplz API.
Error messages:
"Unknown bill operation: create"— indicates a misconfiguration of the operation parameter; ensure "Create" is selected.- API error responses will be passed through; check the message for details such as invalid parameters or authentication failure.
- If the node is set to continue on fail, errors will be included in the output with the error message and context.