Magento Plugin
Copy page
Copy page as Markdown for LLMs
Open in ChatGPT
Ask questions about this page
Open in Claude
Ask questions about this page
Accept payments on your Magento platform using the Amazon Payment Services plugin for seamless payment processing.
Prerequisites
Before you begin, ensure you have:
- Magento 2.2.8 or later installed and configured
- Amazon Payment Services test account for testing
- Magento admin access with extension installation permissions
- SSL certificate installed on your website
- PHP 7.4+ required Magento system requirements
Supported integration types and payment methods
| Supported Integration types | Supported Payment methods |
|---|---|
| Hosted Checkout | Visa, Mastercard, AMEX, MADA, Meeza, Apple Pay, KNET, NAPS, Benefit, OmanNet, STC Pay, Tabby |
| Custom Integration | Visa, Mastercard, AMEX, MADA, Meeza, Apple Pay, STC Pay, valU |
Install the plugin
- Magento Marketplace
- GitHub Download
Download Extension
Visit Magento Marketplace, download the Amazon Payment Services extension.
Install via Composer
Run the following commands to install and enable the extension:
composer require amazonpaymentservices/module-fort
php bin/magento module:enable AmazonPaymentServices_Fort
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush
Verify Installation
Sign in to Magento Admin Panel, navigate to Stores → Configuration → Sales → Payment Methods, and verify that "Amazon Payment Services" appears in the payment methods list.
Download Extension
Visit our GitHub repository and download the latest release.
Upload via SFTP
Connect to your server via SFTP, navigate to your Magento root directory, and copy the extension files to app/code/AmazonPaymentServices/Fort/.
Enable and Compile
Run the following commands to enable and compile the extension:
php bin/magento module:enable AmazonPaymentServices_Fort
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:flush
Verify Installation
Check that the module appears in Stores → Configuration → Advanced → Advanced and confirm "Amazon Payment Services" is listed under Payment Methods.
Configure the plugin
Required Credentials
Before configuring the plugin, gather these credentials from your Amazon Payment Services test account by navigating to Security Settings tab where you will find:
merchant_identifier- Your unique merchant IDaccess_code- API access code for authenticationrequest_sha_phrase- SHA phrase for request signingresponse_sha_phrase- SHA phrase for response verificationsha_type- Hashing algorithm (SHA256 or SHA512)
Configuration Steps
Navigate to Payment Settings
Go to Stores → Configuration → Sales → Payment Methods, find "Amazon Payment Services" in the payment methods list, and click Configure to open configuration.
Configure Global Settings
Complete the following core settings:
| Setting | Description |
|---|---|
| Sandbox Mode | Select Yes for testing environment; No for production/live account |
| Command | Set as PURCHASE for direct capturing of the amount or AUTHORIZATION for holding the amount and capturing it later on |
| SHA Type | Value should be the same as the value under security settings in your account |
| Gateway Currency | If you are using Magento multi-currency: 1. Select Front which uses the customer's selected currency. 2. Select Base which uses store's default currency. If multi-currency is disabled, both options are the same. Note: Make sure the currency you will process payments with is active on your Amazon Payment Services account |
| Debug Mode | Enable debug mode to save all transaction logs |
| Log URL | View detailed logs by following the link. Use the date selector in the upper right corner to find specific logs. All request and response data is stored in JSON format. To find a specific order, search the log file using the order_id |
| Host to Host URL | This is used as a Webhook URL. Host to Host URL needs to be set in your Amazon Payment Services account for feedback and transaction notifications under Technical Settings tab |
| Enable Tokenization | Enable if you need your customers to securely save cards on Amazon Payment Services. The Save My Card button appears for Debit/Credit Card and Installment payments. Saved cards can be managed in the My Account page in Magento |
| Hide delete token button | Allows users to delete saved cards in their Account, except for those linked to active subscriptions |
Credit/Debit configuration
| Setting | Description |
|---|---|
| Enabled | Should be Yes |
| Integration Type | Select the type that is active on your account, Redirection or Custom Integration |
| Title | Set the title for this payment option |
| Sort Order | On the checkout page, you can manage orders for all payment options |
| Show Mada Branding | Enable if you are in KSA and have MADA active on your account |
| Show Meeza Branding | Enable if you are in EGY and have Meeza active on your account |
| Mada Bins | New Mada BINs can be added as they are introduced. The latest BINs are supported by setting a default value for this field |
| Meeza Bins | New Meeza BINs can be added as they are introduced. The latest BINs are supported by setting a default value for this field |
Please do not change any of the configured BINs configuration unless it is instructed by Amazon Payment Services Integration team.
Apple Pay configuration
| Setting | Description |
|---|---|
| Enabled | Yes: Enables this payment option. No: Disables this payment option |
| SHA Type | Algorithm used by the plugin and Amazon Payment Services to verify requests and responses. Must match the Amazon Payment Services account |
| Apple Pay Button Types | Choose the type of Apple Pay button |
| Access Code | Obtain this value from the Amazon Payment Services account |
| Request SHA Phrase | Obtain this value from the Amazon Payment Services account |
| Response SHA Phrase | Obtain this value from the Amazon Payment Services account |
| Domain Name | The domain where Magento is running |
| Supported Networks | Select the card brands available for Apple Pay |
| Production Key | Password specified during Apple Pay certificate creation process |
| Apple Pay Certificates | Upload payment processing certificates received from Apple. Requires a certificate file and a certificate key file |
| Title | Set the title for this payment option |
| Sort Order | On the checkout page, you can manage orders for all payment options |
| Display Name on Apple Pay | This will appear on the Apple Pay popup during payment |
If you have chosen Redirection integration type, Apple Pay will be displayed on the payment page, you do not need to do any Apple Pay configurations.
KNET configuration
Configure only if you are in KWT and have KNET payment option active on your Amazon Payment Services account.
| Setting | Description |
|---|---|
| Enabled | Yes: Enables this payment option. No: Disables this payment option |
| Title | Set the title for this payment option |
| Sort Order | On the checkout page, you can manage orders for all payment options |
NAPS configuration
Configure only if you are in Qatar and have NAPS payment option active on your Amazon Payment Services account.
| Setting | Description |
|---|---|
| Enabled | Yes: Enables this payment option. No: Disables this payment option |
| Title | Set the title for this payment option |
| Sort Order | On the checkout page, you can manage orders for all payment options |
Installments Configuration
| Setting | Description |
|---|---|
| Enabled | Yes: Enables this payment option. No: Disables this payment option |
| Integration Type | Choose from three integration types: Redirection: Users are redirected to Amazon Payment Services to enter payment details. Standard Checkout: Users stay on the merchant's checkout page; an Amazon Payment Services hosted form appears in an iframe. Hosted Checkout: Users stay on Magento, and the card form is hosted by Magento, with host-to-host communication between Magento and Amazon Payment Services |
| Installment Order Purchase Minimum Limit (SAR) | Default: 1100 SAR. The minimum order amount (including tax) required for installment purchases. Must match the installment plan threshold in Amazon Payment Services Back Office |
| Installment Order Purchase Minimum Limit (AED) | Default: 1100 AED. The minimum order amount (including tax) required for installment purchases. Must match the installment plan threshold in Amazon Payment Services Back Office |
| Installment Order Purchase Minimum Limit (EGP) | Default: 1100 EGP. The minimum order amount (including tax) required for installment purchases. Must match the installment plan threshold in Amazon Payment Services Back Office. Minimum order limits apply only to these three currencies, but installment plans may be available in others |
| Show Issuer Name | Check this box to display the bank/issuer name on the checkout page for installment plans |
| Show Issuer Logo | Check this box to display the bank/issuer logo on the checkout page for installment plans |
| Title | Set the title for this payment option |
| Sort Order | On the checkout page, you can manage orders for all payment options |
In case of saved cards, the first 6 digits of saved (masked) card will be used to fetch installment plan.
valU configuration
Configure only if you are in Egypt and have valU payment option active on your account.
| Setting | Description |
|---|---|
| Enabled | Yes: To enable this payment option. No: To disable this payment option |
| VALU Order | Minimum order limit in EGP. The total amount (including tax) required to place the order with Valu |
| Title | Set the title for this payment option |
| Sort Order | On the checkout page, you can manage orders for all payment options |
Tabby configuration
Configure only if you are in UAE/KSA and have TABBY payment option active on your Amazon Payment Services account.
| Setting | Description |
|---|---|
| Enabled | Yes: Enables this payment option. No: Disables this payment option |
| Title | Set the title for this payment option |
| Sort Order | On the checkout page, you can manage orders for all payment options |
Tokenization configuration
| Setting | Description |
|---|---|
| Enabled | This option allows customers to securely save their card information in the Amazon Payment Services system. The "Save My Card" button will appear in the Debit/Credit Card and Installment payment options. Customers can also view their saved cards on the My Account page in Magento |
Cron Setup configuration
| Setting | Description |
|---|---|
| Cron Command | Set up this cron on your live server. It runs every hour to check the payment status of pending orders from Amazon Payment Services and updates them in the system |
| Set Duration | Defines how far back the cron should check for pending orders. For example, if set to 30 minutes, it will process orders placed 30 minutes ago |
Capture, Void & Refund
- Capture
- Void
- Refund
Full and partial captures are supported by following these steps:
Access Order Details
Go to the order detail page and check Capture/Void Authorization section, select capture action and enter the order total amount.
Submit Capture
Click on Submit.
- For a partial capture, enter an amount lower than the authorized amount.
- For a full capture, enter the exact authorized amount.
- Capturing more than the authorized amount is not allowed.
Void through your Magento admin panel by following these steps:
Access Order Details
Go to the order detail page and check Capture/Void Authorization section, select void action.
Submit Void
Click on Submit.
Voiding more than the authorized amount is not allowed.
For refunds, refer to the default behavior of Magento.
To refund from the Magento admin panel using Amazon Payment Services, use the Refund via Amazon Payment Service button instead of the Refund Manually button. The Refund Manually button won't trigger Amazon Payment Services API to refund the amount back to the customer.
For the orders that are processed with the Authorization command, refund will be available only after the amounts are captured. Amounts more than captures can't be refunded.
Test the integration
To test your integration with Amazon Payment Services plugin:
Add Product to Cart
Add a product to your cart.
Proceed to Checkout
Proceed to checkout and enter required details for checking out.
Test Payment
Pay by using one of our testing cards.
Visit this go-live checklist to go live with Amazon Payment Services plugin on Magento.