Magento Plugin Configuration

After the plugin is installed you will need to do some required configuration for the checkout option to become available. Below we outline which configuration is required, and which other configurations you can change.

Go to the configuration section for Amwal Payments

In your Magento admin panel, navigate to Stores > Configuration > Sales > Payment methods. On this page, under the “Other payment methods” section, you will find the configuration section for Amwal.

Generic configuration

1. Enable the plugin
To enable the plugin please change the “Enabled” setting to “Yes”

Merchant settings

1. Merchant ID
Here you will fill in your Merchant ID. You can find or create your Merchant ID in your Merchant account on https://merchant.sa.amwal.tech/.

You can also use the “Verify Merchant ID” button to make sure your merchant ID is entered correctly.

2. Module Type

This option allows you to choose between two versions of the Amwal module:

Pro: Enables all the features of the Amwal extension, including payment options available at the product level (PDP), category level (PLP), and the standard checkout process.

Lite: A simplified version of the module that only works with the regular checkout process, disabling other features such as payments from product and category pages.

3. Secret Key
This is a secret key that is used to authenticate the plugin with the Amwal Payments API. Please do not share this key with anyone. If you believe your key has been compromised, please contact Amwal Payments support immediately.

4. Installment URL
This is the URL to the installment options page. This page will be displayed to the customer when they click the “Installments” button on the checkout page. Please ensure that this URL is correct and that the page is accessible to your customers.

Visual settings

1. Title
This is the title of the payment method that is shown during the regular checkout process.

2. Dark Mode
Changes the appearance of the checkout button. When set to “Off” the button will be black with white text, and when set to “On” the button will be white with black text. Adjust this to fit the look and feel of your store.

3. Style CSS
This is where you can add custom CSS to style the checkout button. This is useful if you want to change the size, color, or font of the button. You can also use this to hide the button on certain pages. For example, if you want to hide the button on the cart page, you can add the following CSS:

.amwal-express-checkout-button.product-detail-page,  .box-tocart .action.tocart{
    width: 70%;
}

@media (max-width: 767px) {
    .amwal-express-checkout-button.product-detail-page {
        width: unset;
    }

    .catalog-product-view .hydrated center {
        text-align: right;
        background: #fff;
        position: fixed;
        bottom: 0;
        left: 0;
        z-index: 9999;
        width: 100%;
    }
    .button-text {
        padding-left: 0 !important;
    }
    .products-grid .product-item-actions .amwal-express-checkout-button {
        width: 90% !important;
    }
   
   .ribbon~.button-text{
        font-size: 10px !important;
    }
}

.product-item-actions .actions-primary, .actions-secondary{
  width: 100%;
}

4. Discount Ribbon
When set to “On” a ribbon will be displayed on the checkout button to indicate that a discount is available. When set to “Off” the ribbon will not be displayed. Adjust this to fit the look and feel of your store.

Installments Settings

The Installments Settings section allows you to configure options related to installment payments. These settings provide flexibility for customers to pay for their orders in installments, enhancing their purchasing experience.

1. Custom Installments Redirect URL
The URL to which the user should be redirected after selecting the installment option. Note: Make sure to include either the http:// or https:// protocol.

Example: Tabby and Tamara.

2. Bank Installments
This feature is only available for orders with a minimum amount of 1,000 SAR. For more details, visit our Bank Installments page.

Promotion Settings

1. Discount Rule
Select the discount rule you want to apply to this promotion. In this example, "25% Off" is selected.

2. Credit Card BIN Codes
Enter the BIN codes of the credit cards that will be eligible for this promotion. In this example, the BIN codes entered are "5454, 1234, 12345138".

Order settings

1. Order confirmed status
The status that should be assigned to the order in Magento after the payment has been successfully processed.
2. Create customer on order creation
This option allows you to create a new customer account in Magento when a new order is created in Magento.
3. Send email when order status changed to customer
This option allows you to send an email to the customer when the order status is changed in Magento by the cron job or the Amwal order details button.
4. Send email when order status changed to admin
This option allows you to send an email to the admin when the order status is changed in Magento by the cron job.

Country Specific Settings

1. Payment from Applicable Countries
Indicated if the payment method should be available for all countries, or a selected list of countries. To limit the allowed countries set this option to “Specific countries”

2. Payment from Specific Countries
If the “Payment from Applicable Countries” is set to “Specific countries” you can select the countries that should be allowed to use the Amwal checkout option here.

Debug mode
If enabled this option will log additional information during the checkout process. Should be disabled in production environments and only be activated for debugging purposes.

Cron Job Settings

This Cron Job plays a crucial role in maintaining order processing efficiency. It is specifically designed to periodically check and update the status of orders that are currently marked with a 'Pending Payment' status. By running at regular intervals, this automated process ensures timely updates, reducing manual intervention and helping maintain accurate and up-to-date order status information in the system.

Frequency
Cron Job Frequency is 1 hours.

Jobs
1. Update Pending Orders
This job retrieves all orders that are currently marked with a 'Pending Payment' status from -1 hour. It then checks the status of these orders with the payment gateway and updates the order status accordingly.

2. Update Canceled Orders

This job retrieves all orders that are currently marked with a 'Canceled' status from -1 hour. It then checks the status of these orders with the payment gateway and updates the order status accordingly.

Developer Settings

1. Debug mode
If enabled this option will log additional information during the checkout process. Should be disabled in production environments and only be activated for debugging purposes.

2. Report errors to Sentry
If enabled, this option will report any errors that occur during the checkout process to Amwal sentry.

3. PWA Mode
If you are using any PWA frameworks this setting will help you much as you can as headless integration.

4. Quote override
If enabled, will override certain quote data. Use only if you are having issues related to quote amounts or currencies.

Amwal Apple Pay

The Amwal Apple Pay payment method allows customers to complete their purchases using Apple Pay. This feature is designed to enhance the user experience by providing a quick and secure payment option.

Please note that Amwal Apple Pay is only available on the regular checkout page.

Amwal Bank Installments

The Amwal Bank Installments payment method allows customers to make purchases using installment plans. This option is only available during the regular checkout process.

It provides flexibility for customers to manage their payments over a specified period while enjoying the products offered.