BCL icon

BCL

Consume BCL Payment API
Join our community

Actions20

Overview

This node integrates with the BCL Payment API to manage coupons, among other resources. Specifically, the Coupon - List operation retrieves a paginated list of coupons from the BCL system. This is useful for workflows that need to display, analyze, or process multiple coupons at once, such as marketing automation, reporting, or coupon validation tasks.

Practical examples include:

  • Fetching active coupons to display in an e-commerce platform.
  • Retrieving all coupons matching a search term for auditing purposes.
  • Sorting coupons by creation date to identify recent promotions.

Properties

Name Meaning
Page Page number of the results to retrieve (minimum 1).
Per Page Number of items per page (minimum 1, maximum 100).
Search Search term to filter coupons by code or description.
Sort By Field to sort the results by: Code, Created At, or Updated At.
Sort Order Order of sorting: Ascending or Descending.
Status Filter coupons by status: All, Active, or Inactive.

Output

The node outputs an array of JSON objects representing coupons retrieved from the BCL API. Each object corresponds to a coupon and includes its details as returned by the API, such as coupon code, description, discount amount/type, status, and timestamps.

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • Authentication failed: If the API token is invalid or expired, the node will return an authentication error. Verify and update the API token credential.
  • Validation errors: Improper parameter values (e.g., invalid page number) may cause validation errors. Ensure input parameters conform to expected types and ranges.
  • Bad request: Malformed requests or unsupported parameters can trigger bad request errors. Double-check property values.
  • Forbidden: Insufficient permissions on the API token will result in forbidden errors. Confirm the token has required access rights.
  • Not found: Requesting non-existent resources will yield not found errors. Check resource identifiers.
  • Server errors: Temporary issues on the BCL server may cause 5xx errors. Retry after some time or contact support if persistent.

If "Continue On Fail" is enabled, the node will output error details in the JSON output instead of stopping execution.

Links and References

Discussion