# BCL API

> BCL is a Malaysian platform for payment forms, events, bookings and payment links. This is the reference for the BCL API v1: payment links, forms, event forms, customers, participants, coupons, protected content, automations and transactions.

- Interactive reference: https://api-reference.bcl.my/
- OpenAPI document: https://api-reference.bcl.my/openapi/v1.yaml (also https://api-reference.bcl.my/openapi/v1.json)
- Base URL (Production. Use this address for all new integrations.): https://api.bcl.my/v1
- Base URL (Legacy. The old address. Use it only for the integrations that use it now.): https://bcl.my/api
- Authentication: a bearer token (`Authorization: Bearer <token>`).
- Help centre for merchants: https://docs.bcl.my/ (its own index: https://docs.bcl.my/llms.txt)

## Payments

- Payment links: Create a payment link (`POST /payment-link`)
- Payment links: Get the status of a payment link (`GET /transaction/{orderNumber}`)
- Transactions: List transactions (`GET /transactions`)
- Transactions: Get transaction statistics (`GET /transactions/stats`)
- Transactions: Get a transaction (`GET /transactions/{orderNumber}`)

## Forms and events

- Payment forms: List payment forms (`GET /forms`)
- Payment forms: Get a payment form (`GET /forms/{id}`)
- Payment forms: Duplicate a payment form (`POST /forms/duplicate`)
- Payment forms: Change the status of a payment form (`PATCH /forms/{id}/status`)
- Payment forms: Show a payment form on the homepage (`PATCH /forms/{id}/homepage`)
- Payment forms: Change the slug of a payment form (`PATCH /forms/{id}/slug`)
- Payment forms: Change the title of a payment form (`PATCH /forms/{id}/title`)
- Payment forms: Change the content of a payment form (`PATCH /forms/{id}/content`)
- Payment forms: Change the stock of a payment form (`PATCH /forms/{id}/stock`)
- Payment forms: Change the prices of a payment form (`PATCH /forms/{id}/prices`)
- Payment forms: Change the affiliate options of a payment form (`PATCH /forms/{id}/affiliate`)
- Payment forms: Change the redirect URLs of a payment form (`PATCH /forms/{id}/redirect-urls`)
- Payment forms: Change the webhook of a payment form (`PATCH /forms/{id}/webhook`)
- Payment forms: Change the Facebook pixel of a payment form (`PATCH /forms/{id}/facebook-pixel`)
- Payment forms: Change the TikTok pixel of a payment form (`PATCH /forms/{id}/tiktok-pixel`)
- Payment forms: Change the coupon rules of a payment form (`PATCH /forms/{id}/coupon`)
- Event forms: List event forms (`GET /event-forms`)
- Event forms: Get an event form (`GET /event-forms/{id}`)
- Event forms: Change the slug of an event form (`PATCH /event-forms/{id}/slug`)
- Event forms: Change the name of an event form (`PATCH /event-forms/{id}/venue-name`)
- Event forms: Change the content of an event form (`PATCH /event-forms/{id}/content`)
- Event forms: Change the status of an event form (`PATCH /event-forms/{id}/status`)
- Event forms: Show an event form on the homepage (`PATCH /event-forms/{id}/homepage`)
- Event forms: Change the ticket stock of an event form (`PATCH /event-forms/{id}/tickets`)
- Event forms: Change the ticket prices of an event form (`PATCH /event-forms/{id}/ticket-prices`)
- Event forms: Change the affiliate options of an event form (`PATCH /event-forms/{id}/affiliate`)
- Event forms: Change the redirect URLs of an event form (`PATCH /event-forms/{id}/redirect-urls`)
- Event forms: Change the webhook of an event form (`PATCH /event-forms/{id}/webhook`)
- Event forms: Change the Facebook pixel of an event form (`PATCH /event-forms/{id}/facebook-pixel`)
- Event forms: Change the TikTok pixel of an event form (`PATCH /event-forms/{id}/tiktok-pixel`)
- Event forms: Change the coupon rules of an event form (`PATCH /event-forms/{id}/coupon`)
- Participants: Search participants (`GET /participants`)
- Participants: Change a participant (`PATCH /participants/{id}`)
- Participants: List the participants of an event (`GET /event-forms/{id}/participants`)
- Homepage showcase: List the forms for the homepage (`GET /showcase/forms`)

## Customers and access

- Customers: List customers (`GET /customers`)
- Customers: Get a customer (`GET /customers/{id}`)
- Coupons: List coupons (`GET /coupons`)
- Coupons: Get a coupon (`GET /coupons/{id}`)
- Coupons: Change a coupon (`PATCH /coupons/{id}`)
- Coupons: Change the status of a coupon (`PATCH /coupons/{id}/status`)
- Coupons: Create a coupon (`POST /coupons/coupons`)
- Protected content: List protected content (`GET /protected-contents`)
- Protected content: Get protected content (`GET /protected-contents/{id}`)
- Protected content: List the customers of protected content (`GET /protected-contents/{id}/customers`)
- Protected content: Change the status of protected content (`PATCH /protected-contents/{id}/status`)
- Protected content: Change the title of protected content (`PATCH /protected-contents/{id}/title`)
- Protected content: Change the access rules of protected content (`PATCH /protected-contents/{id}/access`)

## Automations

- Automations: List automations (`GET /automations`)
- Automations: Get an automation (`GET /automations/{id}`)
- Automations: List the executions of an automation (`GET /automations/{id}/executions`)
- Automations: Get the statistics of an automation (`GET /automations/{id}/stats`)

## Optional

- [Full text of the reference](https://api-reference.bcl.my/llms-full.txt): every guide and endpoint with its fields