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 "Collection" resource and "Get a Bill" operation, it retrieves detailed information about a specific bill within a collection by its Bill ID. This is useful for checking the status or details of a payment request at any time.

Common scenarios include:

  • Verifying payment status after sending a bill.
  • Retrieving bill details for record-keeping or reporting.
  • Automating follow-up actions based on bill status in workflows.

Example: After creating a bill and sending it to a customer, you can use this node to fetch the bill's current status (paid, pending, expired) to trigger notifications or update your database.

Properties

Name Meaning
Collection ID The unique identifier of the collection that contains the bill. A string value.

(Note: For the "Get a Bill" operation, the node requires the Bill ID property as well, but since only Collection ID was provided, this table reflects the given input.)

Output

The node outputs a JSON array where each item corresponds to the retrieved bill object from Billplz API. The JSON structure includes all details of the bill such as:

  • Bill ID
  • Collection ID
  • Amount
  • Recipient email or mobile
  • Status of the bill (e.g., paid, pending)
  • Description
  • Callback URL
  • Other metadata returned by the Billplz API

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for Billplz API authentication.
  • Makes HTTP requests to Billplz API endpoints (https://www.billplz.com/api/v3/bills/{BILL_ID}).
  • Needs proper configuration of the API credentials in n8n to authorize requests.

Troubleshooting

  • Invalid or missing Bill ID: The node requires a valid Bill ID to retrieve the bill. Ensure the Bill ID is correctly provided and exists in your Billplz account.
  • Authentication errors: If the API key credential is incorrect or missing, the node will fail to authenticate. Verify the API credentials are set up properly.
  • Network issues or API downtime: Connectivity problems or Billplz service outages may cause request failures. Check network connectivity and Billplz status.
  • Permission issues: The API key used must have permission to access the requested collection and bill data.

Common error messages typically relate to HTTP 401 Unauthorized (bad credentials), 404 Not Found (invalid Bill ID), or 400 Bad Request (malformed parameters). Resolving these involves verifying inputs and credentials.

Links and References

Discussion