Overview
This node integrates with the Billplz payment gateway API, allowing users to manage collections, bills, and banking information programmatically within n8n workflows. Specifically, for the Collection - Get operation, it retrieves detailed information about a specific collection by its ID.
Typical use cases include:
- Fetching details of a payment collection to verify its status or metadata.
- Integrating collection data into automated reporting or CRM systems.
- Using collection info as part of a larger payment processing workflow.
For example, you might use this node to get a collection's title and ID before creating bills under that collection or to confirm collection details before generating invoices.
Properties
| Name | Meaning |
|---|---|
| Collection ID | The unique identifier of the collection to retrieve. This is selected from existing collections loaded dynamically via the API. |
Output
The node outputs a JSON object representing the requested collection's details. This typically includes fields such as the collection's ID, title, creation date, and other metadata provided by the Billplz API.
No binary data output is produced by this operation.
Example output structure (simplified):
{
"id": "collection_id",
"title": "Collection Title",
"created_at": "2023-01-01T00:00:00Z",
// ... other collection properties
}
Dependencies
- Requires an active connection to the Billplz API using an API key credential configured in n8n.
- The node uses the Billplz REST API endpoint
https://www.billplz.com/api. - The "Collection ID" property options are dynamically loaded by calling the Billplz API to list available collections.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication errors.
- Selecting a non-existent or deleted Collection ID will result in an error from the API.
- Network connectivity problems can prevent API calls from succeeding.
Error messages:
"Unknown collection operation: get"— indicates a misconfiguration of the operation parameter; ensure "Get" is selected.- API errors returned from Billplz (e.g., 404 Not Found) usually mean the specified collection ID does not exist.
"Unknown resource: collection"— means the resource parameter is incorrectly set; should be "collection" for this operation.
Resolutions:
- Verify API credentials and permissions.
- Confirm the Collection ID exists by checking the dynamic dropdown or via the Billplz dashboard.
- Ensure stable internet connection.
- Use the "Continue On Fail" option in the node settings to handle errors gracefully in workflows.