Skip to main content

Step 1: Understanding Workflow & Prerequisites

Before using Reports API, it’s essential to understand the workflow and prerequisites. This ensures your business can effectively utilize the platform's capabilities to use Reports APIs. From setting up API integrations to configuring the needed parameters, every step plays a crucial role in managing your Reports APIs.

For a comprehensive guide on configuring and managing Report APIs, including detailed instructions and requirements, please refer to the Manuals below. It covers all the necessary information to help you get started and optimize the process of using Reports APIs efficiently.

Reports Workflow

In summary, the Reports API workflow offers merchants a streamlined and organized method for managing their Reports. Here's the key steps:

  1. Access to Merchant Dashboard: Ensure you have access to the Merchant Dashboard and permission to view the Reports menu.
  2. Create Active Report Layout: Within the Reports menu, create a layout by adding the fields you want to include in the report’s Excel sheets. For more details, check the following: Reports Menu Via Merchant Dashboard.
  3. Request Report List:After creating an active layout, reports will be generated based on the selected period (daily, weekly, or monthly). Once the period ends, use the endpoint to retrieve the report list, which includes IDs, dates, and other details. Report List Endpoint
  4. Request Download Report: From the report list, choose which reports to download based on the data available. Some reports may be empty, so download only the relevant ones using the report ID through the download report endpoint Download Endpoint

By leveraging this workflow, merchants can automate their Reports management by using the following APIs. For more information on setting up and optimizing your Report process, please refer to our related manual for detailed API documentation and best practices.

Reports prerequisites

Below, you will find a list of all the requirements/prerequisites that you must have ready before starting your Reports integration journey. Please read them carefully and check the associated solution articles when needed:

  1. Access to Merchant Dashboard:
    To be able to generate and manage reports, you must have active access to your PayTabs merchant dashboard. Ensure that your login credentials are valid and that you can navigate to the Reports menu.


  2. Create Active Report Layout:
    Within the Reports menu, you need to create a report layout by adding the fields you want to include in the generated Excel sheets. This step is essential to ensure that your reports contain the correct data points for your business needs.
    For more details, check the following: Reports Menu Via Merchant Dashboard.

The prerequisites and flow are now complete. Please proceed to the next steps to explore the endpoints.

We are glad to be always in help. We aim to serve you better each time. As such, please spare a minute to share feedback about your recent experience with PayTabs Developers , on Trustpilot, or Google Reviews.