Overview
This node integrates with the Billplz payment gateway API to manage billing-related operations. Specifically, for the Bill resource and the Delete operation, it allows users to delete a specific bill by its ID. This is useful in scenarios where a bill needs to be canceled or removed from the system, such as when a payment request was created in error or is no longer valid.
Practical example:
- Automatically deleting bills that are expired or invalidated in your workflow.
- Cleaning up test or temporary bills after processing payments.
Properties
| Name | Meaning |
|---|---|
| Bill ID | The unique identifier of the bill to delete. This is required to specify which bill to remove. |
Output
The output is a JSON array containing the result of the delete operation for each input item. Typically, this will include confirmation data returned by the Billplz API indicating whether the deletion was successful. If an error occurs, the output may contain an error message describing the failure.
No binary data is output by this operation.
Dependencies
- Requires an API key credential for authenticating with the Billplz payment gateway.
- The node uses the base URL
https://www.billplz.com/apifor all requests. - No additional external dependencies beyond the Billplz API and n8n's HTTP request capabilities.
Troubleshooting
- Common issues:
- Providing an invalid or non-existent Bill ID will cause the delete operation to fail.
- Network or authentication errors if the API key is missing, invalid, or lacks proper permissions.
- Error messages:
"Unknown bill operation: delete"— indicates a misconfiguration of the operation parameter; ensure "Delete" is selected.- API errors returned from Billplz (e.g., "Bill not found") should be checked and handled accordingly.
- To resolve errors, verify the Bill ID is correct, ensure the API key credential is properly configured, and check network connectivity.
Links and References
- Billplz API Documentation – Official API docs for detailed information on bill management endpoints.