-
Notifications
You must be signed in to change notification settings - Fork 25
Home
kdevjanr edited this page Jul 18, 2023
·
9 revisions
This document describes Amazon Payment Services extension for Magento and includes information on how to use it with your APS Backoffice.
This document was created for users to integrate the Amazon Payment Services extension for Magento with their Magento application.
We know that payment processing is critical to your business. With this plugin we aim to increase your payment processing capabilities. Do you have a business-critical questions? View our quick reference documentation for key insights covering payment acceptance, integration, and reporting.
Simply download it from Magento Marketplace
or
execute below command in your magento installation directory
composer require amazonpaymentservices/module-fort
- Authorization, purchase, capture, void, and refund
- Credit and Debit Card
- Installments
- ValU
- Apple Pay
- KNET
- NAPS
- Tabby
Below mentioned functions are not supported in this release. They are planned for the upcoming releases. Please feel free to get in touch with [email protected] for further enquiries.
- Multishipping
- Magento PWA
- Connect via SFTP and navigate to [your site root folder]
- Copy APS extension for Magento folder under app/code folder
- Compile Magento
- Follow the configuration steps mentioned in Step 3
Follow the below instruction to access configuration page of APS extension for Magento:
- Navigate to Stores → Configuration
- At left hand side click on Sales → Payment Methods
- Under Other Payment Methods section find a payment methods names as “Amazon Payment Services”
- Click on Configure button
If you don't have an APS account click here to sign up for Amazon Payment Services account https://paymentservices.amazon.com/ Have any questions? Just get in touch -- email the team at [email protected]
You can obtain the value of these fields from the APS account.
- Merchant Identifier
- Access Code
- Request SHA Phrase
- Response SHA Phrase
| Configuration Type | Configuration Description |
|---|---|
| Sandbox Mode | You can change the behavior of the extension to decide whether it will work in Sandbox mode (Used on stage server for testing and dummy payment capture) or in Live mode (Used on Live server for real payment capture) |
| Command | AUTHORIZATION: If the command is set as “AUTHORIZATION” then the order amount will not be deducted from the user card/bank at the time of placing the order. Merchants need to manually capture it from the APS Back Office or from the Order detail page in the Magento admin panel.PURCHASE: If the command is set as “PURCHASE” then the order amount will be deducted from the user card/bank at the time of placing the order. |
| SHA Type | This is the algorithm that extension and APS will use to verify the request and response. Keep it the same APS account. |
| Gateway Currency | In the case of a multi-currency, Magento set a default currency for the store and allow the customer to choose any supported currency. In this scenario this field decides while interacting with APS which currency will be used. If it is set as “Front” then interaction will happen in customer chosen currency and if it is set as “Base” then Magento store default currency will beused. If a merchant is not using multicurrency, it means base currency and front currency are the same. |
| Debug Mode | If Debug mode is enabled all transaction logs will be saved. Logs can be checked here [Your site root folder]var/log/debug.log |
| Host to Host URL | This is used as a Webhook URL. Host to Host URL needs to be set in the APS account for feedback and transaction notifications. |
| Credit Card Types | Please don’t change anything in that, we need it to put some validations on cart no length. |
| Configuration Type | Configuration Description |
|---|---|
| Enabled | Yes : To enable this payment option. No : To disable this payment option |
| Integration Type | There are three types of integration available and merchants can select any type as per requirements. Redirection: Users will be redirected to APS website to enter the payment details on APS hosted page. Standard Checkout: Users will stay on the merchant checkout page but an APS checkout form will open in Iframe to enter the payment details. The form is hosted by APS. Hosted Checkout: Users will stay on the Magento checkout page, card form will be hosted by the Magento. Communication will happen host to host between Magento and APS. |
| Title | Set the title for this payment option. |
| Sort Order | On the checkout page orders of all payment options that come under this extension can be managed from here. |
| Show Mada Branding | Enable via checking the box if you wish to display the mada logo on the checkout page with all mada branding guidelines. |
| Show Meeza Branding | Enable via checking the box if you wish to display the meeza logo on the checkout page with all meeza branding guidelines. |
| Mada Bins | Mada Bins can be managed from here. In future if new bins get introduced then it can be supported by adding here. All latest bins are supported here by setting a default value of this field. Note : Please do not change any of the below BINs configuration unless it is instructed by APS Integration team. For further inquiries: [email protected] |
| Meeza Bins | Meeza Bins can be managed from here. In future if new bins get introduced then it can be supported by adding here. All latest bins are supported here by setting a default value of this field. |
Note : Please do not change any of the below BINs configuration unless it is instructed by APS Integration team. For further inquiries: [email protected]
| Configuration Type | Configuration Description |
|---|---|
| Enabled | Yes : To enable this payment option. No : To disable this payment option |
| Certificate Key Pem File | Upload the payment processing certificates that you received from Apple while setting up Apple pay. Upload certificate key file here. This field becomes mandatory when Apple Pay option is enabled. |
| Certificate Pem File | Upload the payment processing certificates that you received from Apple while setting up Apple pay. Upload certificate file here. This field becomes mandatory when Apple Pay option is enabled. |
| Title | Set a title for this payment option. |
| Access Code | You can obtain the value of the field from the APS account. This parameter will only be shown if the Payment method is enabled with field on 4.a |
| Request SHA Phrase | You can obtain the value of the field from the APS account. This parameter will only be shown if the Payment method is enabled with field on 4.a |
| Response SHA Phrase | You can obtain the value of the field from the APS account. This parameter will only be shown if the Payment method is enabled with field on 4.a |
| Sort Order | On the checkout page orders of all payment options that come under this extension can be managed from here. |
| SHA Type | This is the algorithm that extension and APS will use to verify the request and response. Keep it the same APS account. |
| Certificate (Production) Key | The key used for generating the certificate in your Apple Pay account. This parameter will only be shown if the Payment method is enabled with field on 4.a |
| Domain Name registered on Apple Pay account | Domain name on which Magento system is running. This parameter will only be shown if the Payment method is enabled with field on 4.a |
| Display Name on Apple Pay | It will display on Apple pay Popup while making payment. This parameter will only be shown if the Payment method is enabled with field on 4.am. Apple Pay Button Types. The type of Apple pay button can be chosen here. |
| Apple Pay Supported Networks | The list of Cards Brands can be chosen to be available in Apple Pay. |
- Enabled
- Yes : To enable this payment option
- No : To disable this payment option
- Title: Set a title for this payment option.
- Sort Order: On the checkout page orders of all payment options that come under this extension can be managed from here.
- Enabled
-
Yes : To enable this payment option
-
No : To disable this payment option
- Title: Set a title for this payment option.
- Sort Order: On the checkout page orders of all payment options that come under this extension can be managed from here.
- Enabled
- Yes : To enable this payment option
- No : To disable this payment option
- Title: Set a title for this payment option.
- Integration Type: There are two types of integration available and Merchant can select any type as per his requirements.
- Redirection: Users will be redirected to the service provider website to enter the payment details.
- Hosted Checkout: Users will stay on the Magento checkout page and on clicking the Visa Checkout button a Visa Checkout popup will open to complete the checkout.
- API Key: This will be provided by Amazon Payment Services.
- Profile ID: This will be provided by Amazon Payment Services.
- Sort Order: On the checkout page orders of all payment options that come under this extension can be managed from here.
| Configuration Type | Configuration Description |
|---|---|
| Enabled | Yes : To enable this payment option No : To disable this payment option |
| Integration Type | There are three types of integration available and Merchant can select any type as per his requirements. Redirection: Users will be redirected to APS website to enter the payment details on APS hosted page. Standard Checkout: Users will stay on the merchant checkout page but an APS checkout form will open in Iframe to enter the payment details. The form is hosted by APS. Hosted Checkout: Users will stay on the Magento checkout page, card form will be hosted by the Magento. Communication will happen host to host between Magento and APS. |
| Title | Set a title for this payment option. |
| Installment Order Purchase minimum limit (SAR) | Default Value: 1100. The minimum order total amount (including Tax) required in SAR to place the order with installment. It should be the same as the installment plan threshold set in APS back office. Installment Order Purchase minimum limit (AED). Default Value: 1100. The minimum order total amount (including Tax) required in AED to place the order with installment. It should be the same as the installment plan threshold set in APS back office. Installment Order Purchase minimum limit (EGP). Default Value: 1100. The minimum order total amount (including Tax) required in EGP to place the order with installment. It should be the same as the installment plan threshold set in APS back office. Minimum order limit is only on these three currencies but there may be installment plans available in other currencies also. |
| Show Issuer Code | Enable via checking the box if you wish to display the Bank/Issuer Name on the checkout page while showing the installment plans. |
| Show Bank Logo | Enable via checking the box if you wish to display the Bank/Issuer logo on the checkout page while showing the installment plans. |
| Sort Order | On the checkout page orders of all payment options that come under this extension can be managed from here. |
Note: In case of saved cards, the first 6 digits of the saved (masked) card will be used to fetch the installment plan. Merchants should enable the masking strategy in APS Backoffice accordingly for hosted installments payment options to work with saved cards. To change card masking in APS Backoffice navigate to Merchant Management > Technical Settings > Merchant Page: Select Visa, MC or Amex. Have any questions? Just get in touch -- email the team at [email protected]
- Enabled
-
Yes : To enable this payment option
-
No : To disable this payment option
- Title: Set a title for this payment option.
- VALU Order Purchase minimum limit in EGP: The minimum order total amount (including Tax) required to place the order with Valu.
- Sort Order: On the checkout page orders of all payment options that come under this extension can be managed from here.
- Enabled
- Yes : To enable this payment option
- No : To disable this payment option
- Enabled: This option is to enable customers to have an option to save their card information on APS system securely. Save My Card button will be shown in Debit/Credit Card and Installments payment options. Customers can also access their saved card information on My Account page of the Magento.
- Cron Command: Please setup this cron on your live server. This cron will run every hour and check the payment status of pending orders from APS and update it in the system.
- Set Duration: This duration will decide that when above cron will run then which pending orders will be picked to check payment status. For Eg : if 30 mins is set then orders which are placed 30 mins before will be picked.
Full and partial captures are supported.
- Go to the order detail page
- Click on Capture/Void Tab at left side
- Choose Capture from Payment Type dropdown
- Enter the order total amount
- Click on Submit button
- Go to the order detail page
- Click on Capture/Void Tab at left side
- Choose Capture from Payment Type dropdown
- Enter the amount you want to capture
- Click on Submit button
• How to void an order from Order Detail page
- Go to the order detail page
- Click on Capture/Void Tab at left side
- Choose Void from Payment Type dropdown
- Click on Submit button
- In case of Capture and Void events triggered from the APS Backoffice, results will be reflected to the Magento admin panel using webhooks (Check Host to Host URL option in configuration settings).
- For refunds, please refer to the default behavior of Magento. When refund is initiated from Magento admin panel an APS API will be triggered that will refund the amount to the customer.
- In case of Refund events triggered from the APS Backoffice, results will be reflected to the Magento admin panel using webhooks (Check Host to Host URL option in configuration settings).
- For the orders that are placed with the Authorization command, Refund will be active after the amounts are captured. Amounts more than captures can’t be refunded.