CS-Cart 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 CS-Cart platform using the Amazon Payment Services plugin for seamless payment processing.
Prerequisites
Before you begin, ensure you have:
- CS-Cart installed and configured
- Amazon Payment Services test account for testing
- CS-Cart admin access with add-on installation permissions
- SSL certificate installed on your website
Supported integration types and payment methods
| Supported Integration types | Supported Payment methods |
|---|---|
| Hosted Checkout | Visa, Mastercard, AMEX, MADA, Meeza, Apple Pay, KNET, NAPS, OmanNet, valU |
| Custom Integration | Visa, Mastercard, AMEX, MADA, Meeza, Apple Pay, valU |
Install the plugin
Download Plugin
Visit our GitHub repository and download the latest release as a .zip file.
Access CS-Cart Admin
Login to your CS-Cart Admin Panel and navigate to Add-ons → Manage Add-ons.
Manual Installation
Click the gear button (⚙️) and select Manual Installation.
Choose Installation Method
Select one of these installation options:
- Local Upload: Upload the downloaded
.zipfile directly from your computer - Server File: Select the
.zipfile from your server location - Remote URL: Enter the direct download URL of the
.zipfile
Activate Plugin
After installation, go to Add-ons → Manage Add-ons, find Amazon Payment Services in the list, and Activate the plugin if not already active.
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 Administration → Payment methods, find "Amazon Payment Services" in the payment methods list, and click on the "Amazon Payment Services to configure the add-on.
Configure Global Settings
Complete the following core settings:
| Setting | Description |
|---|---|
| Enabled | Select Yes to enable the plugin; No to disable the plugin |
| Merchant Identifier | Amazon Payment Services account merchant identifier |
| Access Code | Amazon Payment Services account access code |
| Request SHA Phrase | Amazon Payment Services account SHA Request Phrase |
| Response SHA Phrase | Amazon Payment Services account SHA Response Phrase |
| 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 CS-Cart 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 |
| 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 CS-Cart |
Credit/Debit configuration
| Setting | Description |
|---|---|
| Enabled | Should be Yes |
| Integration Type | Select the type that is active on your account, Redirection or Custom Integration |
| 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 CS-Cart 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 |
| Sort Order | On the checkout page, you can manage orders for all payment options |
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 |
| 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 |
| 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 integration types: Installments: Standard installment integration Embedded Hosted Installments: Installments are embedded in Debit/Credit Card payment option |
| 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 |
| Sort Order | On the checkout page, you can manage orders for all payment options |
valU configuration
Configure only if you are in Egypt and have valU payment option active on your Amazon Payment Services 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 |
| Sort Order | On the checkout page, you can manage orders for all payment options |
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 CS-Cart 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 CS-Cart.
To refund from the CS-Cart 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 CS-Cart.