Overview
This node integrates with the Billplz payment gateway API, specifically focusing on managing collections and bills. The "Collection" resource's "Get Many" operation allows users to retrieve multiple collection records from their Billplz account. This is useful for scenarios where you want to list or process many collections at once, such as generating reports, syncing collections data with other systems, or displaying collections in a dashboard.
For example, a user might want to fetch all collections created within a certain period or limit the number of collections retrieved to avoid processing too much data at once.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all available collection results or only up to the specified limit. |
| Limit | Maximum number of collection results to return when "Return All" is set to false. Range: 1-100. |
Output
The output is a JSON array where each item represents a collection object retrieved from the Billplz API. Each collection object typically contains details such as the collection ID, title, and other metadata provided by the 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
https://www.billplz.com/api. - The node depends on internal helper functions to make authenticated HTTP requests to Billplz.
- No additional external dependencies are required beyond the configured API credentials.
Troubleshooting
Common Issues:
- Authentication errors if the API key credential is missing or invalid.
- Network connectivity issues preventing access to the Billplz API.
- Exceeding API rate limits imposed by Billplz.
Error Messages:
"Unknown collection operation: getAll": Indicates that the operation parameter was not recognized; ensure the operation is correctly set to "Get Many".- Errors related to request failures will include messages from the underlying HTTP request; verify API credentials and network status.
Resolutions:
- Verify that the API key credential is correctly configured and has necessary permissions.
- Check network connectivity and firewall settings.
- Use the "Limit" property to reduce the number of results per request if hitting rate limits.
- Enable "Continue On Fail" option in the node settings to handle partial failures gracefully.