Billplz icon

Billplz

Billplz using API for payment gateway
Join our community

Actions6

Overview

This node integrates with the Billplz payment gateway API to manage collections and bills. Specifically, for the Bill resource with the Get a Collection operation, it retrieves detailed information about a specific collection by its ID.

Common scenarios where this node is useful include:

  • Fetching details of a payment collection to verify its status or metadata.
  • Integrating payment collection data into workflows for reporting or further processing.
  • Automating retrieval of collection info after creation or updates.

Practical example:

  • After creating a collection in Billplz, you can use this node to fetch the collection details by providing the collection ID, enabling you to confirm the collection's properties or use the data downstream in your workflow.

Properties

Name Meaning
Collection ID The unique identifier of the collection to retrieve. A string value (e.g., "346543278").

Output

The node outputs an array of JSON objects representing the collection data returned from the Billplz API. The structure typically includes fields such as collection ID, title, creation date, and other metadata related to the collection.

Example output JSON snippet (simplified):

{
  "id": "346543278",
  "title": "Sample Collection",
  "created_at": "2023-01-01T12:00:00Z",
  "split_rule": {...},
  ...
}

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Billplz API.
  • The node makes HTTP requests to https://www.billplz.com/api/v3/collections/{collection_id} using Basic Authentication.
  • Ensure that the API credentials are correctly configured in n8n before using this node.

Troubleshooting

  • Invalid Collection ID: If the provided collection ID does not exist or is malformed, the API will return an error. Verify the collection ID is correct.
  • Authentication Errors: If the API credentials are missing or incorrect, authentication will fail. Check that the API key credential is properly set up.
  • Network Issues: Connectivity problems may cause request failures. Confirm network access to the Billplz API endpoint.
  • API Rate Limits: Excessive requests might be throttled by Billplz. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion