Overview
This node interacts with the Billplz payment gateway API, specifically to manage bills and their related transactions. The "Get Transactions" operation under the "Bill" resource retrieves transaction records associated with a specific bill. This is useful for scenarios where you want to track payments made against a particular bill, reconcile payments, or generate reports on bill payment statuses.
Practical examples:
- Fetching all payment transactions for a given bill to verify which payments have been completed.
- Retrieving recent transactions for a bill to update your internal accounting system.
- Limiting the number of transactions fetched to display recent activity in a dashboard.
Properties
| Name | Meaning |
|---|---|
| Bill ID | The unique identifier of the bill for which to retrieve transactions. |
| Return All | Whether to return all transaction results or limit the output to a specified maximum count. |
| Limit | Maximum number of transaction results to return if "Return All" is false (1 to 100). |
Output
The node outputs an array of JSON objects representing transactions related to the specified bill. Each object contains details about a single transaction such as payment status, amount, timestamps, and other relevant metadata provided by the Billplz API.
If binary data were involved (e.g., receipts or documents), it would be summarized here, but this operation only returns JSON transaction data.
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. - No additional external dependencies are required beyond the configured API credentials.
Troubleshooting
Common issues:
- Invalid or missing Bill ID will cause the API request to fail.
- Network connectivity problems can prevent successful API calls.
- Exceeding rate limits imposed by Billplz API may result in errors.
Error messages:
"Unknown bill operation: getTransactions": Indicates a misconfiguration of the operation parameter; ensure "Get Transactions" is selected.- API error responses typically include messages about invalid IDs or authentication failures; verify the Bill ID and API credentials.
Resolutions:
- Double-check that the Bill ID is correct and corresponds to an existing bill.
- Ensure the API key credential is valid and has necessary permissions.
- Use the "Return All" property carefully to avoid fetching excessive data that might hit API limits.
Links and References
- Billplz API Documentation – Official API docs for detailed information on endpoints and data structures.
- n8n Documentation – For general usage of the Billplz node within n8n workflows.