# Tamara Documentation and APIs Hub Documentation

## Guides
- [Get to know Tamara](https://docs.tamara.co/docs/introduction-to-tamara.md): Learn more about **Tamara**'s product offerings and how we can help you and your customers!
- [Educational Institutions](https://docs.tamara.co/docs/education.md): For merchants with educational institutions, such as schools, colleges, etc.
- [General](https://docs.tamara.co/docs/general-risk-assessment.md): For all merchant categories
- [Hotel Booking](https://docs.tamara.co/docs/hotel-booking.md): For merchants offering hotel booking, hospitality services, etc.
- [Specific details for risk assessment](https://docs.tamara.co/docs/additional-customer-details-for-risk-assessment.md): Guidelines for optimizing the checkout experience of customers when offering Tamara as a payment option by including more details
- [Marketplace](https://docs.tamara.co/docs/marketplace.md): For merchants offering products/services via multiple vendors
- [Educational Services](https://docs.tamara.co/docs/other-educational-services.md): For merchants offering educational services, such as online courses, subscriptions, etc.
- [Telecom](https://docs.tamara.co/docs/telecom.md): For merchants offering telecommunication services
- [Travel and Hotel Booking](https://docs.tamara.co/docs/travel-and-hotel-booking.md): For merchants offering both flights and hotel booking
- [Travel Booking](https://docs.tamara.co/docs/travel.md): For merchants offering flights booking, OTA merchants, etc.
- [Widgets - Promotional Messaging](https://docs.tamara.co/docs/direct-widgets.md): Read through to review the guidelines for implementing Tamara’s Widgets on your Website and Mobile Application
- [[KSA 🇸🇦] Tamara Widget Implementation Guidelines](https://docs.tamara.co/docs/tamara-widget-implementation-guidelines-saudi-arabia.md)
- [[UAE 🇦🇪] Tamara Widget Implementation Guidelines](https://docs.tamara.co/docs/tamara-widget-implementation-guidelines-uae.md)
- [Webhook Registration & Order Authorisation](https://docs.tamara.co/docs/transaction-authorisation.md): One of the most important steps merchants must do to complete online checkout integration is the Order Authorisation.
- [UAE ID Verification via UAE KYC ](https://docs.tamara.co/docs/uae-id-verification.md): As a merchant using Tamara, ensuring a smooth and secure ID verification process is key to providing your customers with a seamless experience.<br /> <br /> Continue reading if you are integrating with us in the UAE region.
- [Quick Start Guide](https://docs.tamara.co/docs/direct-quick-start-guide.md): This direct integration method uses API requests/responses to pass information between your platform/website/mobile application and **Tamara**. It is the simplest and the easiest method of integration, that will work on just about any platform.
- [In-store Checkout](https://docs.tamara.co/docs/offlineinstore-checkout.md): This method helps you to offer **Tamara** to your in-store customers, either via non-integrated solutions such as the Tamara Partners Portal and Tamara Partners App or via an integrated solution to your in-store POS terminal. 👉 _Click on the desired solution to learn more._
- [Online Order Status Flow](https://docs.tamara.co/docs/online-order-status-flow.md): To integrate with **Tamara** and connect your e-commerce platform with our service, it is necessary to fully understand how the flow of our order statuses work and map them to your system’s statuses.    👉 _Click on any status in the flow to learn more about it._
- [API Token Management](https://docs.tamara.co/docs/api-token-management.md): An API Token is used to identify and authenticate merchants to perform transactions and API requests with **Tamara**.
- [Dispute Management Best Practices](https://docs.tamara.co/docs/dispute-management-best-practices.md): This guide provides a set of best practices for merchants to proactively manage transaction disputes and minimize unresponsiveness, ensuring a positive post-purchase experience.
- [Dispute Management](https://docs.tamara.co/docs/pp-dispute-mgmt.md): **Tamara** Disputes provides a centralized hub for managing customer disputes, giving you a convenient summary of all incoming disputes and highlighting those that need your attention or action.
- [Challenge a disputed order](https://docs.tamara.co/docs/pp-dispute-mgmt-challenge-dispute-order.md): This page details a step-by-step guide on how to challenge a disputed order with the necessary proof and supporting documents.
- [Refunding a disputed order](https://docs.tamara.co/docs/pp-dispute-mgmt-refund-disputed-order.md): This page details a step-by-step guide on how to refund a disputed order
- [Order Management](https://docs.tamara.co/docs/pp-order-mgmt.md): This section covers how to do complete order management using your Tamara Partners Portal account.
- [Authorise an order](https://docs.tamara.co/docs/pp-order-mgmt-authorise-order.md): Once Tamara verifies the customer's payment and approves the order, it's considered as paid, and you should proceed accordingly by authorising the order at your end.
- [Cancel an order](https://docs.tamara.co/docs/pp-order-mgmt-cancel-order.md): **Authorised** orders only will have an option to be cancelled, or updated, thus cancelling or reducing the total amount of the order and refunding the customer their paid amounts.
- [Capture an order](https://docs.tamara.co/docs/pp-order-mgmt-capture-order.md)
- [Create an order](https://docs.tamara.co/docs/pp-order-mgmt-create-order.md): Creating Payment links is a very simple task, this guide covers the how-to.
- [Refund an order](https://docs.tamara.co/docs/pp-order-mgmt-refund-order.md): For any Fully/Partially Captured order, you may issue a refund back to the customer using the **Tamara** Partners Portal.
- [Users and Roles Management](https://docs.tamara.co/docs/pp-role-user-mgmt.md): Learn more about adding users to your Tamara Partners Portal, managing them after creation, and the roles that users can get assigned as well as the accompanying permissions.
- [Adding a new user](https://docs.tamara.co/docs/pp-role-user-mgmt-add-new-user.md): Add team members and set roles to customize access and permissions. Enhance collaboration and security effortlessly.
- [Understanding Roles and Creating a new role](https://docs.tamara.co/docs/pp-role-user-mgmt-create-update-role.md): A role allows a user particular functionality within your Tamara portal so that they can perform a task or set of tasks.
- [Managing a user](https://docs.tamara.co/docs/pp-role-user-mgmt-manage-new-user.md): Manage or edit the users information and roles after creation.
- [Settlement and Invoices (Billings)](https://docs.tamara.co/docs/pp-settlement-invoices.md): Manage your settlement cycle, model and understand more about your settlements' breakdown, download different types of invoices such as Settlement invoice, tax invoice and more.
- [Settlement Dashboard](https://docs.tamara.co/docs/pp-settle-invoice-reports.md): Learn more about when orders are settled, different types of settlement models, and how to change your settlement model.
- [Understanding Settlements](https://docs.tamara.co/docs/pp-settle-invoice-understand-settlements.md): Learn more about when orders are settled, different types of settlement models, and how to change your settlement model.
- [Getting started](https://docs.tamara.co/docs/what-is-the-partners-portal.md): Learn more about Tamara's Partners Portal, what you can do with it and what features does it have.
- [Android SDK](https://docs.tamara.co/docs/android-sdk.md)
- [Flutter SDK](https://docs.tamara.co/docs/flutter-sdk.md)
- [Mobile SDKs](https://docs.tamara.co/docs/mobile-sdks.md)
- [iOS SDK](https://docs.tamara.co/docs/ios-sdk.md)
- [Other SDKs](https://docs.tamara.co/docs/other-sdks.md)
- [React Native SDK](https://docs.tamara.co/docs/react-native-sdk.md)
- [Testing Cards](https://docs.tamara.co/docs/testing-cards.md): **Tamara** supports a wide range of card types such as VISA, MasterCard, MADA and AMEX for customers to choose from. Below are a list of cards that cover most card issuers, types and test cases.
- [In-store Go-Live Testing Checklist](https://docs.tamara.co/docs/in-store-go-live-testing-checklist.md): For in-store POS or QR-code implementation, etc.
- [Go-Live Testing Checklist](https://docs.tamara.co/docs/testing-checklist.md): In this section we will provide you with a list of elaborate cases to validate your integration once the implementation is done from your end. Kindly ensure to follow the checklist, to ensure a smooth go-live.
- [Online Go-Live Testing Checklist](https://docs.tamara.co/docs/online-go-live-testing-checklist.md): For online website, mobile apps implementation, etc.
- [Testing Guide](https://docs.tamara.co/docs/testing-scenarios.md): Ensure a smooth and successful integration with our testing guide tailored for KSA and UAE. Here you can find everything you need to validate your setup, simulate transactions, and confirm readiness on Sandbox environment before going live on Production environment.
- [KSA Testing Guide](https://docs.tamara.co/docs/ksa-testing-guide.md)
- [UAE Testing Guide](https://docs.tamara.co/docs/uae-testing-guide.md): We offer you a sandbox environment to test your integration with **Tamara**. In this section, you will find all the information needed to check and finalize your integration.
- [Configuration](https://docs.tamara.co/docs/magento-configuration.md): The **Tamara** plugin configuration for all Magento 2 versions are the same and can be found on this page.
- [Installation](https://docs.tamara.co/docs/magento-installation.md)
- [Installation](https://docs.tamara.co/docs/opencart-installation.md)
- [Order Management](https://docs.tamara.co/docs/opencart-order-management.md)
- [Platforms Quick Start](https://docs.tamara.co/docs/platforms-quick-start.md): How can I add **Tamara** to my e-commerce store?  **Tamara** is already integrated with many popular e-commerce platforms, so, you can add **Tamara** without having to write any code or waste anytime figuring out how to integrate!  Using our e-commerce plugins in this section, you can be live with **Tamara** in a matter of hours.
- [Installation](https://docs.tamara.co/docs/prestashop-installation.md)
- [Dashboard Installation](https://docs.tamara.co/docs/prestashop-dashboard-installation.md)
- [Manual Installation](https://docs.tamara.co/docs/prestashop-manual-installation.md)
- [Additional Configuration](https://docs.tamara.co/docs/sfcc-additional-configuration.md)
- [Installation](https://docs.tamara.co/docs/sfcc-installation.md)
- [Configuration](https://docs.tamara.co/docs/configuration.md)
- [Tamara Logo on Footer](https://docs.tamara.co/docs/shopify-tamara-logo-on-footer.md)
- [Widgets](https://docs.tamara.co/docs/shopify-widgets.md)
- [Amazon Payment Services](https://docs.tamara.co/docs/amazon-payment-services.md)
- [CCAvenue](https://docs.tamara.co/docs/cc-avenue.md)
- [Checkout.com](https://docs.tamara.co/docs/checkoutcom.md)
- [Osarah Pro (عصارة برو)](https://docs.tamara.co/docs/osarah-pro.md)
- [PayTabs](https://docs.tamara.co/docs/paytabs.md)
- [Qoyod (قيود)](https://docs.tamara.co/docs/qoyod.md)
- [Salla (سلة)](https://docs.tamara.co/docs/salla.md)
- [Shahbandr (شهبندر)](https://docs.tamara.co/docs/shahbandr.md)
- [Techrar (تكرار)](https://docs.tamara.co/docs/techrar.md)

## API Reference
- [Get Dispute Case details](https://docs.tamara.co/reference/get_external-merchants-orders-disputes.md): This API allows you to query all of your disputed orders or filter a specific dispute or subset of disputes based on the query parameters that are used as filters of the results that you will get in the response.
- [Updating disputes by ID](https://docs.tamara.co/reference/post_external-merchants-orders-disputes-dispute-id.md): This API allows you to update an existing dispute with a new comment. NOTE: This API does not allow you to change the state of the dispute, only add a new comment
- [Getting Started with Tamara APIs](https://docs.tamara.co/reference/tamara-api-reference-documentation.md): This is your starting point to enabling **Tamara** as a payment method for your customers.
- [Create In-store SMS Payment Link Checkout Session](https://docs.tamara.co/reference/createinstorecheckoutsession.md): This endpoint facilitates the creation of an In-Store checkout session, where all payment information is sent within the request to send a payment link via SMS message, enabling customer payments via Tamara. <br /> <br /> Please store the `order_id` and `checkout_id` received in response in your DBs as they might be needed later.
- [Create In-store QR Code Checkout Session](https://docs.tamara.co/reference/createinstoreqrcode.md): This endpoint facilitates the creation of an In-Store checkout link that can be converted to a QR code, enabling customer payments via Tamara customer app using the Scan to Pay function. <br /> <br /> Please store the `order_id` and `checkout_id` received in response in your DBs as they might be needed later.
- [In-Store Status Flow](https://docs.tamara.co/reference/in-store-checkout-flow.md): To integrate with **Tamara** and connect your stores/branches with our service, it is necessary to fully understand how the flow of our order statuses work and map them to your system’s statuses.  👉 _Click on any status in the flow to learn more about it._
- [Void Checkout Session](https://docs.tamara.co/reference/voidcheckoutsession.md): This API endpoint provides the functionality to void any In-Store checkout session. This is particularly useful in-store when customers need to make any changes to their orders being paid with Tamara.
- [Authorise Order](https://docs.tamara.co/reference/authoriseorder.md): This endpoint plays a crucial role in the online checkout flow and should be executed upon receipt of the `approved` status webook event from **Tamara**. Its primary function is to update the order status to `authorised` ensuring status synchronization and smooth progression of the online order flow.
- [Cancel Order](https://docs.tamara.co/reference/cancelorder.md): This endpoint is requested to cancel or update the total order amount while order status on `authorised` (before the order is captured or shipping process is done). The order status value will be `canceled` or `updated` based on the modification applied to the total amount.
- [Capture Order](https://docs.tamara.co/reference/captureorder.md): This endpoint is requested to perform a full or partial capture of the order, confirming the fulfillment or shipment of the items to the customer. The order status value will be `fully_captured` or `partially_captured` based on the total amount value sent in the request.
- [Create Checkout Session](https://docs.tamara.co/reference/createcheckoutsession.md): This endpoint facilitates the creation of a checkout session, where all payment information is sent within the request to enable customer payments via Tamara. The response will include `order_id`, `checkout_id` , `status` and `checkout_url`. <br /> <br /> Please store the `order_id` in your DBs to fetch the information about the order later and direct the customer to the `checkout_url` to seamlessly conclude the transaction through Tamara.
- [Online Status Flow](https://docs.tamara.co/reference/online-checkout-flow.md): To integrate with **Tamara** and connect your e-commerce platform with our service, it is necessary to fully understand how the flow of our order statuses work and map them to your system’s statuses.  👉 _Click on any status in the flow to learn more about it._
- [Get Order Details by Tamara's order_id](https://docs.tamara.co/reference/getorderdetails.md): Fetch all the order details available on **Tamara's** side using the unique `order_id` that is issued by **Tamara** for every order whether online or in-store.
- [Update order_reference_id](https://docs.tamara.co/reference/updateorderreferenceid.md): Update `order_reference_id` value that is stored at **Tamara's** side at any point after the original checkout session has been created.
- [Pre-Checkout Eligibility ](https://docs.tamara.co/reference/pre-checkout-eligibility.md): This endpoint helps you to check whether Tamara treats a customer as eligible or not, based on active decline records we hold for that customer.
- [Simplified Refund](https://docs.tamara.co/reference/simplifiedrefund.md): This API is to be used to process refunds for captured orders.
- [Retrieve Merchant API Keys](https://docs.tamara.co/reference/get_channel-partners-merchant-merchantid-api-key.md): Retrieve API, public, and notification keys for an onboarded merchant.
- [Retrieve Merchant Onboarding](https://docs.tamara.co/reference/get_channel-partners-merchant-onboarding-onboardingcode.md): Retrieve merchant onboarding details using onboarding code or external channel partner reference.
- [Create Merchant Onboarding](https://docs.tamara.co/reference/post_channel-partners-merchant-onboarding-create.md): Submit merchant and KYB information to initiate automated onboarding and verification.
- [Retrieve Webhooks](https://docs.tamara.co/reference/get_channel-partners-webhooks.md): Retrieve all webhook configurations registered by the channel partner.
- [Register Webhook](https://docs.tamara.co/reference/post_channel-partners-webhooks-register.md): Register a new webhook to receive onboarding status updates.
- [Refund](https://docs.tamara.co/reference/refund.md): Refund
- [Delete Webhook URL using Webhook ID](https://docs.tamara.co/reference/deletewebhookurlusingwebhookid.md): Delete Webhook URL using Webhook ID
- [Getting Started with Webhooks](https://docs.tamara.co/reference/getting-started-with-webhooks.md): Create and manage the Webhook notification URLs and notifications you receive to keep up to date with the latest status of your orders.
- [Register Webhook URL](https://docs.tamara.co/reference/registerwebhookurl.md): Register a new webhook endpoint that Tamara will post selected events to as notification payload
- [Retrieve Webhook URL using Webhook ID](https://docs.tamara.co/reference/retrievewebhookurlusingwebhookid.md): Retrieve Webhook URL using Webhook ID
- [Update Webhook URL using Webhook ID](https://docs.tamara.co/reference/updatewebhookurlusingwebhookid.md): Update Webhook URL using Webhook ID