Actions6
- Collection Actions
- Bill Actions
Overview
This node integrates with the Billplz payment gateway API to manage collections and bills. Specifically, for the Get a Bill operation under the Bill resource, it retrieves detailed information about a specific bill using its unique Bill ID.
Common scenarios where this node is useful include:
- Checking the status or details of a payment bill after it has been created.
- Verifying payment information before proceeding with further business logic.
- Automating financial workflows that require up-to-date billing data from Billplz.
For example, after creating a bill and sending it to a customer, you can use this node to periodically check if the bill has been paid or to retrieve updated billing details.
Properties
| Name | Meaning |
|---|---|
| Collection ID | The unique identifier of the collection that the bill belongs to. A string (required). |
| Bill ID | The unique identifier of the bill to retrieve. Returned in the Bill object. A string (required). |
Note: For the Get a Bill operation, only the Bill ID property is required and used.
Output
The output is a JSON array containing the bill object returned by the Billplz API. This object includes all details about the bill such as:
- Bill ID
- Collection ID
- Amount
- Recipient details (email, mobile, name)
- Status of the bill (e.g., pending, paid)
- Description
- Callback URL
- Other metadata related to the bill
No binary data is output by this node.
Dependencies
- Requires an active Billplz account with API access.
- Requires an API key credential configured in n8n for authenticating requests to Billplz.
- Uses HTTP Basic Authentication with the provided API credentials.
- Makes HTTPS requests to the Billplz API endpoints.
Troubleshooting
- Invalid Bill ID error: If the Bill ID does not exist or is malformed, the API will return an error. Verify the Bill ID is correct and was obtained from a valid Bill object.
- Authentication errors: Ensure the API credentials are correctly set up and have sufficient permissions.
- Network issues: Check connectivity to
https://www.billplz.com/api/v3/bills/{BILL_ID}. - Missing required parameters: The Bill ID must be provided; otherwise, the request will fail.
Links and References
- Billplz API Documentation – Official API docs for more details on bill objects and endpoints.