1. Getting started¶
Enable/Disable: Tick on this checkbox if you wish to enable/disable Tamara Payment method for Woocommerce on Checkout.
Tamara Settings Help Texts: You can browse some help texts and find solutions for common issues with our plugin.
Credentials Configuration: Where you can input your merchant tokens received from Tamara. This setting specifies whether you will process the live transactions or the simulated transactions using the Tamara Sandbox. Whether you wish to use the Live or Sandbox mode, please fill in the appropriate information (API URL, Merchant Token, Notification Token) provided by Tamara. If you input the wrong token, the plugin will be disabled and an error of incorrect credentials will be shown.
Pay By Later Options: This options is only available after you input your token and save it. The limit amounts for usage of each country based on your token will be fetched from Tamara. You can also update the payment method title in both English and Arabic on checkout.
Pay By Instalments Options: This options will be also available after you save your token, the option fields of each country will be separated. We have various instalment payment options from pay in 3 to pay in 12, it will depend on which is available from your merchant account and show here. You can also update the payment method title of each instalment method in both English and Arabic on checkout.
3. Order status mapping¶
Order status explanation
Order status for payment cancelled from Tamara: The order status is set when its payment is canceled from Tamara.
Order status for payment failed from Tamara: he order status is set when the payment is failed (declined) from Tamara.
Order status for Authorise success from Tamara: The order status is set when the payment is made and authorised successfully from Tamara.
Order status for Authorise failed from Tamara: The order status is set when the payment cannot be authorised from Tamara.
Order status for Capture failed from Tamara: The order status is set when the payment cannot be captured from Tamara.
Order status for cancelling the order from Tamara through Webhook: Map status for order when it is cancelled from Tamara (Order Expired, Order Declined...) through Webhook.
4. Order status trigger¶
Order status explanation
Order status that trigger Tamara capture process for an order: The order status changed by Admin to proceed with the Capture Payment process.
Order status that trigger Tamara cancel process for an order: When you update an order to this status it would connect to Tamara API to trigger the Cancel payment process on Tamara.
- An order can not be canceled if its payment has been captured from Tamara. In this case, please use the WooCommerce “Refund” function instead.
- When making a refund, please choose at least one item to refund.
5. Tamara general settings¶
Enable Cron Job: If you enable this setting, Tamara will use a cron-job to find all completed orders that have not been verified and not authorised or not captured within 180 days and force them to be authorised or captured. It fires an asynchronous call on Admin request to perform this action.
Allowed Shipping Country Codes: Add allowed shipping country codes for your site to use with Tamara (These codes, ISO 3166-1 alpha-2 format, are separated by commas e.g. AE, SA). If the shipping country of an order is not in this list, the Tamara Payment method will be hidden from Checkout.
Default Billing Country Code: Add a default billing country code (ISO 3166-1 alpha-2 format, e.g. AE, SA) to use with Tamara if none is set during the checkout progress.
Enable Tamara Custom Log Message: If you enable this setting, all the message logs will be written and saved to the Tamara custom log file in your upload directory. The message log download link button will be available, after you enable this setting.
Force Enable Billing Phone: If you enable this setting, the billing phone field will be forced to display on checkout screen, which is required to use for Tamara checkout.
Enable Pay Later Popup Widget: If you enable this setting, the Pay Later popup widget will be shown on single product page for the product has its price range between Pay Later min limit and max limit (the maximum price of product to show popup is 200.00 in any currency).
Popup Widget Position: Choose a position where you want to display the Tamara Payment Popup Widget on single product page. Or, you can use shortcode with attributes to show it on custom pages e.g. [tamara_show_popup price="99" currency="SAR" language="en"].
Logo Image URL: Enter the URL of image icon to appear on payment method selecting on checkout. The recommended size must be no larger than 230x60, image format.
Enable Webhook: If you enable this setting, Tamara will use the webhook to handle the Order Declined and Order Expired. 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 for Cancelling from Tamara” option. The Webhook ID will also be shown at the field below.
Tamara Payment Cancel Url: Enter the custom CANCEL url for customers to be redirected to after PAYMENT is CANCELLED (leave it blank to use the default one). You can use action
after_tamara_cancel to handle further actions.
Tamara Payment Failure Url: Enter the custom FAILURE url for customers to be redirected to after PAYMENT is FAILED (leave it blank to use the default one). You can use action
after_tamara_failure to handle further actions.
Excluded Product Ids: Enter the product ids that you want to exclude from using Tamara to checkout (These ids are separated by commas e.g. 101, 205).
Excluded Product Category Ids: Enter the product category ids that you want to exclude from using Tamara to checkout (These ids are separated by commas e.g. 26, 104).
Enable Beautiful Merchant Urls: If you enable this setting, the URLs for handling webhook will be beautified.
For example, the Tamara payment success is https://woocommerce.tamara.co?pagename=tamara-payment-success If you enable this setting, it will change to: https://woocommerce.tamara.co/tamara-payment-success After enabling this, please go to "Dashboard => Settings => Permalinks" and click on Save changes to take effect.
Merchant URLs: Where you can track which URLs are used for its corresponding page.
Debug Info: To display the debug information with the PHP version and its loaded extensions used for the plugin.
6. Payment types limits and its caching¶
If you use this plugin on the first time, you need to put your API URL, Merchant Token and Notification token to the forms first and Save the settings. Then, based on payment types available for your tokens, please tick to enable Pay Later or Pay In X according to your usage and Save Setting the second time for the payment methods to appear on your website. Country payment types and limit amounts cache will be saved and updated every 10 minutes, if you need to update your adjusted limits with Tamara, simply click Save changes or refresh the settings screen without changing anything for the plugin to refresh the limits cache.
If you experience issues with payment types and limit amounts, we recommend you click on Save changes to save settings, so the cached limit amounts will be cleared and updated again by pulling updates from Tamara.
7. The Notification URL and Webhook URL¶
Notification URL is used to handle instant Payment Notification from Tamara to update order. It's used when a payment is completed, Tamara API will sent the notification to check if the payment is authorised or not.
We use the
Notification URL to receive the response and handle further actions.
Webhook URL is your webhook endpoint used to receive notifications from Tamara when order information is updated (status changes).
You have to enable the webhook setting to make this feature work. When a webhook is retrieved, a unique webhook id from Tamara is sent, we use this to receive response from Tamara API to handle the order status on our site (for Order Declined and Order Expired).