Bayarcash icon

Bayarcash

Consume Bayarcash API

Actions7

Payment Intent → Create

AI-generated

Overview

This node creates a payment intent using the Bayarcash API. It is useful for initiating payment requests in various payment channels, allowing users to specify details such as the portal, order number, amount, payer information, and callback URLs. Practical applications include e-commerce platforms or services that need to generate payment intents for customer transactions.

Use Case Examples

  1. Creating a payment intent for an online order with specified amount and payer details.
  2. Setting up multiple payment channels for a payment intent to offer customers various payment options.

Properties

Name Meaning
Payment Channel Select one or more payment channels to be used for the payment intent. If left empty, all available channels are listed. By default, only the FPX channel is activated for new accounts.
Portal Name or ID Select or specify the portal key where the payment intent will be created. This is required.
Order Number Unique order number for the payment intent. This is required.
Amount Amount for the payment, between 1.00 and 30,000.00. This is required.
Payer Name Name of the person making the payment. This is required.
Payer Email Email address of the person making the payment. This is required.
Payer Telephone Number Telephone number of the person making the payment, currently only accepts Malaysia numbers.
Callback URL Server-to-server callback URL for POST method to receive payment status updates.
Return URL Server-to-browser redirect URL for GET method after payment completion.
Platform ID Optional platform identifier for the payment intent.

Output

JSON

  • id - ID of the created payment intent
  • portal_key - Portal key associated with the payment intent
  • order_number - Order number of the payment intent
  • amount - Amount specified for the payment intent
  • payer_name - Name of the payer
  • payer_email - Email of the payer
  • payer_telephone_number - Telephone number of the payer (if provided)
  • callback_url - Callback URL for server-to-server notifications (if provided)
  • return_url - Return URL for browser redirection (if provided)
  • platform_id - Platform ID associated with the payment intent (if provided)
  • payment_channel - Payment channel(s) used for the payment intent

Dependencies

  • Bayarcash API with an API token credential

Troubleshooting

  • Authentication errors due to invalid or expired API token. Ensure the API token is valid and correctly configured.
  • Validation errors if required fields are missing or incorrectly formatted. Check that all required fields (portalKey, orderNumber, amount, payerName, payerEmail) are provided and valid.
  • Bad request errors if parameters are improperly formatted or out of allowed ranges (e.g., amount outside 1.00 to 30,000.00).
  • Forbidden errors if the user does not have permission or the payment channel is not enabled for the account.
  • Not found errors if the specified portal or other resources do not exist.
  • Server errors from Bayarcash API indicating temporary issues; retry later or contact support.

Links

Discussion