-
Notifications
You must be signed in to change notification settings - Fork 6
Home
kdevjanr edited this page Jul 25, 2023
·
2 revisions
This document describes our extension for Opencart platform and includes information on how to use it with your APS Backoffice.
This document was created for users to integrate the Amazon Payment Services Opencart extension with their Opencart application.
- Login to [Admin Panel] of Opencart website
- Navigate to Extensions-> Installer
- Click on “Upload” and choose the extension zip file
- Under Install History section click on “Install”
- Follow the configuration steps mentioned in Step 3
- Connect via SFTP and navigate to [your site root folder]
- Copy Opencart APS extension folder under root folder
- Navigate to Extensions-> Extensions
- Under “Choose the extension type” choose Payments
- Under Payments section find a payment methods names as “Amazon Payment Services”
- Click on Install icon
- Follow the configuration steps mentioned in Step 3
Follow the below instruction to access configuration page of APS Opencart extension:
- Navigate to Extensions -> Extensions
- Under “Choose the extension type” choose Payments
- Under Payments section find a payment methods names as “Amazon Payment Services”
- Click on edit icon
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 integration-ps@amazon.com
| Configuration Type | Configuration Description |
|---|---|
| Enabled | Yes : To enable this payment gateway extension. No : To disable this payment gateway extension |
| Merchant Identifier | The ID of the Merchant.You can obtain the value of this field from the APS account. |
| Access Code | Access code. Example: zx0IPmPy5jp1vAz8Kpg7. You can obtain the value of this field from the APS account. |
| Request SHA Phrase | SHA Request Phrase. You can obtain the value of this field from the APS account. |
| Response SHA Phrase | SHA Response Phrase. You can obtain the value of this field from the APS account. |
| 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 Opencart 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, Opencart 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 Opencart store default currency will be used. 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]/system/storage/logs/ |
| 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. |
| Enable Tokenization | 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 Opencart. |
| Hide delete token button | Allows users to delete all saved cards in my account section. If a card is saved for any subscription product purchase, customers won’t be allowed to delete the respective card in My Account -> Payment Methods section. |
| 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 Opencart checkout page, card form will be hosted by the Opencart. Communication will happen host to host between Opencart and APS. |
| Show Mada Branding | Enable using the check box if you wish to display the mada logo on the checkout page with all mada branding guidelines. |
| Show Meeza Branding | Enable using the check 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: integration-ps@amazon.com |
| 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: integration-ps@amazon.com |
| 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 |
|---|---|
| Certificate | Upload Apple Pay Certificates By clicking on this link you can upload the merchant identity certificates that you received from Apple while setting up Apple pay. There are two types of file one is certificate file and one is certificate key file. (.crt pem and .key.pem) |
| Enabled | - Yes : To enable this payment option - No : To disable this payment option |
| SHA Type | This is the algorithm that extension and APS will use to verify the request and response. Keep it the same APS account. |
| Apple Pay Button Types | The type of Apple pay button can be chosen here. |
| Access Code | You can obtain the value of the field from the APS account. |
| Request SHA Phrase | You can obtain the value of the field from the APS account. |
| Response SHA Phrase | You can obtain the value of the field from the APS account. |
| Domain Name | Domain name on which Opencart system is running. |
| Supported Networks | The list of Cards Brands can be chosen to be available in Apple Pay. |
| Production Key | The same key used while exporting the Apple Pay certificate to .p12 format. |
| 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 |
| 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 |
| 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 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 Opencart 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 Opencart checkout page, card form will be hosted by the Opencart. Communication will happen host to host between Opencart and APS. |
| 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. Have any questions? Just get in touch -- email the team at integration- ps@amazon.com |
| Show Issuer Name | Enable if you wish to display the Bank/Issuer Name on the checkout page while showing the installment plans. |
| Show Issuer Logo | Enable 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 integration-ps@amazon.com
| Configuration Type | Configuration Description |
|---|---|
| Enabled | - Yes : To enable 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. |
| Configuration Type | Configuration Description |
|---|---|
| CRON Recurring Order | Set this cron for subscription type orders. It will check and deduct the recurring payments. |
| CRON Check Order Payment Status | Set this cron to check the payment status of pending orders from APS. |
| CRON Check Status Duration | This duration will decide that when above cron (point b) 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. |
Opencart supports subscription products and the order of those products. Opencart doesn’t support recurring payments so recurring payments are supported by APS Opencart extension. To set up recurring payments please set up a daily cron. To find the cron path check point no 4.10.a.
Full and partial captures are supported.
- How to capture full amount from Order Detail page:
- Go to the order detail page
- Go to Amazon Payment Services tab under Order History section
- Enter the order total amount
- Click on Capture button
- How to capture partial amount from Order Detail page:
- Go to the order detail page
- Go to Amazon Payment Services tab under Order History section
- Enter the amount you want to capture
- Click on Capture button
- How to void an order from Order Detail page
- Go to the order detail page
- Go to Amazon Payment Services tab under Order History section
- Click on Void button
- In case of Capture and Void events triggered from the APS Backoffice, results will be reflected to the Opencart admin panel using webhooks (Check Host to Host URL option in configuration settings).
For refunds, Opencart doesn’t support refunds so our extension is providing it.
- How to Refund an order from Order Detail page
- Go to the order detail page
- Go to Amazon Payment Services tab under Order History section
- Enter the amount you want to refund
- Click on Refund button
- In case of Refund events triggered from the APS Backoffice, results will be reflected to the Opencart 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