BCL icon

BCL

Consume BCL Payment API

Overview

This node interacts with the BCL Payment API to manage forms, payment links, and coupons. Specifically, for the Form - List operation, it retrieves a paginated list of forms from the BCL system. This is useful when you want to fetch multiple forms with filtering, sorting, and pagination options.

Common scenarios include:

  • Displaying a list of available forms in an automation workflow.
  • Searching for specific forms by title or other attributes.
  • Sorting forms by creation date, update date, or other fields.
  • Filtering forms based on their active/inactive status.

Example use case: You want to automate reporting or synchronization of your online forms by fetching all active forms sorted by their last update date.

Properties

Name Meaning
Page The page number of results to retrieve (minimum 1).
Per Page Number of items per page (minimum 1, maximum 100).
Search A search term to filter forms by matching text.
Sort By Field to sort the results by. Options: Title, Created At, Updated At, Slug.
Sort Order Direction of sorting. Options: Ascending, Descending.
Status Filter forms by status. Options: All, Active, Inactive.

Output

The output is a JSON array where each item represents a form object retrieved from the BCL API. Each form object contains details such as form ID, title, slug, status, creation and update timestamps, and other metadata as provided by the API.

No binary data is output by this operation.

Dependencies

  • Requires an API token credential for authenticating with the BCL Payment API.
  • The node makes HTTP requests to https://bcl.my/api.
  • Proper configuration of the API token credential in n8n is necessary.

Troubleshooting

  • Authentication failed: If you receive an error about invalid or expired API token, verify that the API token credential is correctly configured and valid.
  • Validation errors: These occur if input parameters are malformed or missing required values. Check that pagination numbers are within allowed ranges and that filters are correctly specified.
  • Not found errors: If no forms are returned or a resource is not found, ensure the API endpoint and parameters are correct.
  • Server errors: Temporary issues on the BCL server side may cause 5xx errors; retry after some time.
  • If the node is set to continue on fail, errors will be included in the output JSON with error details.

Links and References

  • BCL Payment API Documentation (assumed base URL, check official docs)
  • n8n HTTP Request Node documentation for understanding request/response handling
  • General REST API pagination and filtering best practices

Discussion