Configuration¶
1. Get started¶
To configure, Click on the ‘pencil icon’.
2. API configuration¶
2.1 Api Environment:
- Sandbox: for Testing.
- Production: for Live.
2.2 Merchant Token: Your merchant token provided by Tamara.
2.3 Notification Token: Your notification token provided by Tamara.
2.4 Enable trigger to Tamara: If enabled, this option allows you to automatically trigger Capture and Cancel order to Tamara when you perform corresponding action in Magento or not. If disabled, you need to integrate with our APIs directly or use our Partners Portal to do so.
2.5 Enable Tamara checkout success page: If enabled, this option allows you to use Tamara template in the checkout page (Only available when 2.7 is empty)
2.6 Display under/over warning message at checkout page: If enabled, the extension will display a warning message at the checkout page if the cart total amount is over/ under Tamara limits for payment. Otherwise, hide unavailable payment methods.
2.7 Checkout success redirect URL: This option allows you to customise the URL that you want redirect to after the customer’s successful payment with Tamara.
2.8 Checkout cancel redirect URL: This option allows you to customise the URL that you want redirect to after the customer’s canceled payment on Tamara.
2.9 Checkout failure redirect URL: This option allows you to customise the URL that you want redirect to after the customer’s failed payment with Tamara.
2.10 Don’t show Tamara widget on product(ids): This option allows to hide Tamara widget on these products, also to hide Tamara payment on checkout page if your cart has any of these items. Each ID is separated by a comma ",".
2.11 Don’t show Tamara widget on category(ids): This option allows to hide Tamara widget on products under these categories, also to hide Tamara payment on checkout page if your cart has any of these items. Each ID is separated by a comma ",".
2.12 Only show Tamara for these customers: The option allows only these customers to be able to use Tamara. This option is useful when you want to test and don’t want real customers to use Tamara. Each customer email ID is separated by a comma ",".
2.13 Enable Webhook:
- Yes: If enabled, Tamara will use the webhook to handle the Order Declined and Order Expired scenarios. After a certain time, the order that has been declined or expired from Tamara, will be updated to the status that is set in “Order status when checkout is cancelled” or “Order status when checkout is failure” field.
2.14 Webhook Id: Your webhook ID; this field will be shown after you enable webhook and save the configuration.
3. Payment types¶
Enable or disable payment types that you want to show on the checkout page.
After updating this option, Click on ‘Pull / flush payment types’.
4. Order Status Mapping¶
Set the Checkout order statuses
4.1 Order status when order is created: The status that you want to set when the order is created.
4.2 Order status when checkout is a success (after redirect): The status that you want to set when the payment is successful with Tamara.
4.3 Order status when checkout is failure: The status that you want to set when the payment is failed (declined) from Tamara.
4.4 Order status when checkout is canceled: The status that you want to set when its payment is canceled from Tamara.
4.5 Order status when order is authorised: The status that you want to set when the payment is made and authorised successfully from Tamara.
Following are the statuses corresponding to Tamara:
| Status | Description |
|---|---|
| Approved | Payment is approved by Tamara and the customer has finished the checkout flow then redirect back to the merchant site. |
| Failed (Declined) | Payment is declined by Tamara. |
| Canceled | Payment is canceled by the customer from Tamara checkout. |
| Authorised | Tamara sends an authorisation callback and gets confirmation from the merchant (OpenCart) successfully. Orders should only be shipped at this state, otherwise tamara will not assume the risk and therefore cannot settle to your account. |
5. Order Status Trigger¶
5.1 Which order status do you want to trigger Tamara capture API (You should set it to the status after the order is shipped): The status that you want the extension to trigger Tamara API to proceed with the Capture payment process. Trigger to Tamara is mandatory in this case. [Ref. Configuration 2.4]
5.2 Which order status do you want to trigger Tamara cancel API? (You should set it to the status when order is canceled): The status that you want the extension to trigger Tamara API to proceed with the Cancel payment process. Trigger to Tamara is mandatory in this case. [Ref. Configuration 2.4]
6. General configuration¶
6.1 Enable debug: If enabled, this option allows the module to write logs to file. It is useful to trace if a problem occurs.
6.2 Geo Zone: The shipping zones that are allowed to use Tamara.
6.3 Status: This option is used to enable/disable Tamara on Checkout.
6.4 Sort order: This option is used to sort the order of payment methods on the checkout page.