Overview
This node integrates with the Billplz payment gateway API, specifically allowing users to manage bills within their Billplz account. The "Get" operation for the "Bill" resource retrieves detailed information about a specific bill using its unique Bill ID.
Common scenarios where this node is beneficial include:
- Fetching the status and details of a particular bill to display or process further in an automation workflow.
- Verifying payment information or bill metadata before triggering subsequent actions.
- Integrating billing data retrieval into custom dashboards or reporting tools.
Practical example:
- A user wants to automatically check the status of a bill after sending it to a customer. Using this node's "Get Bill" operation, they can retrieve the bill details by providing the Bill ID and then use the output to determine if the bill has been paid or is still pending.
Properties
| Name | Meaning |
|---|---|
| Bill ID | The unique identifier of the bill to retrieve. This is required to specify which bill to fetch. |
Output
The node outputs a JSON object representing the retrieved bill's details. This typically includes all relevant information about the bill such as its ID, amount, description, customer details, status, creation date, due date, and any other metadata provided by the Billplz API.
No binary data output is involved in 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. - Proper configuration of the API key credential in n8n is necessary for successful requests.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Bill ID will likely result in an error from the API indicating that the bill could not be found.
- Missing or incorrect API credentials will cause authentication failures.
- Network connectivity issues may prevent the node from reaching the Billplz API.
Error messages:
"Unknown bill operation: get": This indicates a misconfiguration in the operation parameter; ensure "Get" is selected for the "bill" resource.- API errors related to authorization or invalid Bill ID will be returned from the Billplz API and surfaced by the node. Verify the Bill ID and API key correctness.
Resolution tips:
- Double-check the Bill ID input for typos or outdated values.
- Confirm that the API key credential is correctly set up and has sufficient permissions.
- Test connectivity to the Billplz API outside n8n to rule out network issues.
Links and References
- Billplz API Documentation – Official API docs for understanding bill properties and endpoints.
- n8n Documentation – For general guidance on setting up credentials and using nodes.