BCL icon

BCL

Consume BCL Payment API

Actions20

Payment Link → Create

AI-generated

Overview

This node creates a new payment link using the BCL Payment API. It is useful for scenarios where you want to generate a payment request for a specific amount and payer details, allowing the payer to complete the payment through a generated link. For example, it can be used by businesses to send payment links to customers for invoices or orders.

Use Case Examples

  1. Create a payment link for a customer to pay an invoice of MYR 100.
  2. Generate a payment link with payer details and optional remarks for tracking.

Properties

Name Meaning
Amount The payment amount in Malaysian Ringgit (MYR) to be requested via the payment link.
Payer Name The name of the person who will make the payment.
Payer Email The email address of the payer to send or associate with the payment link.
Payer Telephone Number The Malaysian mobile phone number of the payer in the format 012-3456789.
Portal Key The Bayarcash Portal Key used to authenticate and associate the payment link with a specific portal.
Additional Fields Optional additional parameters for the payment link such as order number, payment channel, user payment choice, and remarks.

Output

JSON

  • amount - The amount requested for payment.
  • payer_name - Name of the payer.
  • payer_email - Email address of the payer.
  • payer_telephone_number - Telephone number of the payer.
  • portal_key - Portal key used for the payment link.
  • order_number - Unique order number for the transaction.
  • payment_channel - Selected payment channel for the transaction.
  • let_user_choose_payment - Flag indicating if user can choose payment method.
  • remarks - Remarks or notes associated with the payment link.
  • payment_link_url - The URL of the created payment link (implied from API response).

Dependencies

  • BCL Payment API
  • An API token credential for authentication

Troubleshooting

  • Authentication errors due to invalid or expired API token. Ensure the API token is correct and has not expired.
  • Validation errors if required fields like amount, payer details, or portal key are missing or incorrectly formatted.
  • Bad request errors if parameters are improperly formatted or invalid.
  • Permission errors if the API token does not have access to create payment links.
  • Server errors from the BCL API indicating temporary issues; retry later or contact support.

Links

Discussion