GuidesAPI ExplorerService StatusPartners PortalWidget DocsSupport

Configuration

Suggest Edits

1. Getting Started

To start configuring your Tamarapay OpenCart plugin, Click on the blue ‘pencil icon’.

2. API Configuration Section

Click to enlarge

Click to enlarge

  1. API Environment
    1. Sandbox: to be used during sandbox testing phase before going live.
    2. Production: to be used after you receive your live credentials from Tamara so that you can perform live transactions.
  2. Merchant Token:
    1. Sandbox: API Bearer Authorization token received from Tamara to be used during sandbox testing phase before going live.
    2. Production Token: API Bearer Authorization token received from Tamara so that you can perform live transactions.
  3. Notification Token:
    1. Sandbox Notification Token: Notification Authorization token received from Tamara to be used during sandbox testing phase before going live to validate notification payload is being sent by Tamara.
    2. Production Notification Token: Notification Authorization token received from Tamara to validate notification payload is being sent by Tamara.
  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 OpenCart or not. If disabled, you need to integrate with Tamara APIs directly or use Tamara Partners Portal to do so.
  5. Enable Tamara checkout success page: If enabled, this option allows you to use Tamara template in the checkout page (Only available when point 7. is empty)
  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.
  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.
  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.
  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.
  10. Don’t show Tamara widget on product(ids): This option allows to hide Tamara widget on specific product Ids, also to hide Tamara payment on checkout page if your cart has any of these items.
    Each ID is separated by a comma ,
  11. Don’t show Tamara widget on category(ids): This option allows to hide Tamara widget on products under specific categories based on their category Ids, also to hide Tamara payment on checkout page if your cart has any of these items.
    Each ID is separated by a comma ,
  12. Only show Tamara for these customers: The option allows only specific customers to be able to use Tamara. This option is useful when you want to test Tamara checkout and don’t want real customers to use Tamara yet.
    Each customer email ID is separated by a comma ,
  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 under [[Ref. Configuration 4.3]](/docs/opencart-configuration#4-order-status-mapping-section)
  1. Webhook Id: Your webhook ID; this field will be shown after you enable webhook[13.] and save the configuration.

3. Order Status Mapping Section

  1. Order status when order is created: The status that you want to set when the order is created.
  2. Order status when checkout is a success (after redirect): The status that you want to set when the payment is successful using Tamara.
  3. Order status when checkout is failure: The status that you want to set when the payment is failed (declined) from Tamara.
  4. Order status when checkout is canceled: The status that you want to set when payment is canceled on Tamara checkout.
  5. Order status when order is authorised: The status that you want to set when the 1st payment is successful and authorised successfully from Tamara.

Following are the statuses corresponding to Tamara order status:

StatusDescription
ApprovedPayment 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.
CanceledPayment is canceled by the customer from Tamara checkout.
AuthorisedTamara 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.

4. Order Status Trigger Section

  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]
  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]

5. General Configuration Section

  1. Enable debug: If enabled, this option allows the module to write logs to file. It is useful to trace if a problem occurs.
  2. Geo Zone: The shipping zones that are allowed to use Tamara.
  3. Status: This option is used to enable/disable Tamara on Checkout.
  4. Sort order: This option is used to sort the order of payment methods on the checkout page.

Updated 8 months ago