Payment Button
A sophisticated payment gateway integration component designed to streamline online transaction processes. Provides a secure, customizable button for initiating payments with comprehensive event handling, API integration, and support for complex payment scenarios including partial payments. Ideal for e-commerce, subscription services, and financial applications.
Extends: baseComponent
Fields
Name | Code | Data Type | Description |
|---|---|---|---|
Label |
| multi-locale | The text displayed on the payment button (supports multilingual labels) |
Resource ID |
| text | Unique identifier for the payment button component |
Style Classes |
| text | Additional CSS classes to customize button appearance |
Width Class |
| text | Controls the width of the button using predefined CSS classes |
Visibility |
| boolean | Controls whether the payment button is displayed or hidden |
Enabled |
| boolean | Determines if the payment button is interactive or disabled |
Loading |
| boolean | Shows loading state during payment processing |
Color |
| text | Sets the color theme of the payment button |
Icon |
| text | Icon to display before the button label |
Right Icon |
| text | Icon to display after the button label |
Size |
| text | Sets the size of the button component |
Flat |
| boolean | Removes button background when enabled |
Outline |
| boolean | Shows button with outlined style |
Round |
| boolean | Makes the button completely circular |
Rounded |
| boolean | Adds rounded corners to the button |
No Caps |
| boolean | Prevents automatic text capitalization |
Show Tooltip |
| boolean | Enables tooltip display on hover |
Tooltip Style Classes |
| text | CSS classes for styling the tooltip |
Tooltip Value |
| text | Text content displayed in the tooltip |
Business Name |
| text | Name of the business displayed in the payment gateway interface |
Company Logo |
| text | URL of the company logo shown in the payment window |
Theme |
| text | Custom theme configuration for payment gateway user interface |
Payment Action API |
| text | Resource ID for the API used to initiate payment |
Payment Failure API |
| text | Resource ID for handling payment failure scenarios |
Payment Success API |
| text | Resource ID for processing successful payment transactions |
Amount |
| text | Monetary amount to be processed in the payment |
Currency |
| text | Currency code for the payment transaction |
Receipt ID |
| text | Unique identifier for the payment receipt |
Notes |
| text | Additional notes or comments for the payment transaction |
Partial Payment |
| boolean | Enables support for partial payment options |
First Payment Minimum Amount |
| text | Minimum amount required for the initial partial payment |
Methods
Name | Description |
|---|---|
| Initiates the payment process by creating an order and starting the gateway |
| Generates a payment order by calling the specified initiation API |
| Opens the payment gateway interface with configured payment parameters |
| Handles successful payment processing and calls the success API |
| Manages payment failure scenarios and calls the failure handling API |
| Performs additional validation of the payment transaction |
Events
Name | Description |
|---|---|
| Triggered when the payment process is initiated |
| Triggered when the payment is completed successfully |
| Triggered when the payment process encounters an error or fails |