### PayTabs API Endpoints Introduction

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-1-Setup-and-Activate-Integration-Method/System%20Requirements

Provides an introduction to PayTabs API Endpoints, guiding users on how to start integrating with the PayTabs payment gateway.

```APIDOC
PT API Endpoints:
  Introduction: Guides users through the initial steps and concepts of integrating with the PayTabs API.
  Related Manuals:
    - Integration Types Manuals: Detailed guides for different integration scenarios.
    - Invoices APIs: Specific documentation for invoice-related functionalities.
```

--------------------------------

### Laravel Integration Setup and Activation

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-1-Setup-and-Activate-Integration-Method/Laravel-Setup-Activate-and-Upgrade-the-integration-method

This section details the initial steps for integrating PayTabs into a Laravel project. It covers system requirements, package installation, activation, and uninstallation.

```PHP
composer require paytabs/paytabs-laravel
php artisan vendor:publish --provider="Paytabs\PaytabsLaravel\PaytabsLaravelServiceProvider"
php artisan migrate
php artisan config:cache
```

--------------------------------

### Laravel Integration Setup and Activation

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-1-Setup-and-Activate-Integration-Method/system-requirements

Guides users through the initial setup and activation of PayTabs integration methods within a Laravel project. This includes understanding system requirements and the activation process.

```APIDOC
Laravel Integration:
  Step 1 - Setup and Activate the Integration Method:
    - System Requirements: Details the necessary system configurations for Laravel integration.
    - Setup, Activate and Upgrade the integration method: Provides instructions on how to set up, activate, and upgrade the payment integration.
    - Supported Payment Methods: Lists the payment methods supported by the integration.
```

--------------------------------

### PayTabs PayLinks API - Step 1: Setup and Activate Integration

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/PayLinks-Step-4-Accepting-the-payment/PayLinks-Step-4-Landing

Guide for setting up and activating the PayLinks integration method within the PayTabs system.

```APIDOC
PayLinks API - Step 1: Setup and Activate the Integration Method

This step outlines the initial configuration required to enable PayLinks for your account.

Actions include:
- Accessing the PayTabs merchant dashboard.
- Navigating to the integration settings.
- Selecting and activating the PayLinks method.
- Obtaining necessary API credentials (e.g., API keys, merchant ID).
```

--------------------------------

### PayTabs Node.js Integration Steps

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/NodeJS-Setup-Activate-and-Upgrade-the-integration-method/Uninstall-the-package

Overview of the integration process for PayTabs in Node.js applications, from initial setup to handling payment responses.

```Node.js
# Step 1: Setup and Activate the Integration Method
# Refer to: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/
```

```Node.js
# Step 2: Configure the integration method
# Refer to: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Configure-the-integration-method
```

```Node.js
# Step 3: Initiating the payment
# Refer to: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJS-Step-3-Initiating-the-payment/NodeJs-Step-3-Landing
```

```Node.js
# Step 4: Accepting the payment
# Refer to: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/accepting-the-payment
```

```Node.js
# Step 5: Handle the payment response
# Refer to: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/Handle-the-payment-response
```

```Node.js
# Step 6: Handle the post-payment responses (notifications)
# Refer to: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/handle-the-post-payment-responses-notifications
```

```Node.js
# Step 7: Manage Transactions
# Refer to: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/laravel-Step-7-Manage-Transactions/
```

--------------------------------

### Install PayTabs Node.js Package

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/NodeJS-Setup-Activate-and-Upgrade-the-integration-method/Install-and-activate

Command to install the paytabs_pt2 package using npm in your project's command line.

```bash
npm i paytabs_pt2
```

--------------------------------

### Node.js Integration Setup and Activation

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method

This section details the process of setting up and activating the PayTabs Node.js backend package for payment gateway integration. It covers system requirements and essential steps for a smooth integration.

```Node.js
/*
  This is a conceptual representation of the Node.js integration setup.
  Actual implementation details would involve specific PayTabs SDK usage.

  1. System Requirements:
     - Node.js installed (version specified by PayTabs documentation).
     - npm or yarn package manager.
     - PayTabs merchant account credentials (API Key, Secret Key, Profile ID).

  2. Installation:
     npm install paytabs-nodejs-sdk
     or
     yarn add paytabs-nodejs-sdk

  3. Initialization:
     const PayTabs = require('paytabs-nodejs-sdk');
     const paytabs = new PayTabs({
       profileId: 'YOUR_PROFILE_ID',
       serverKey: 'YOUR_SERVER_KEY',
       region: 'your_region' // e.g., 'SY' for Syria, 'EG' for Egypt
     });

  4. Setup and Activation:
     // This typically involves configuring your PayTabs merchant dashboard
     // and potentially setting up callback URLs within the SDK or dashboard.
     // Refer to PayTabs documentation for specific activation steps.

  5. Upgrade:
     // If an upgrade is needed, follow the instructions provided by PayTabs
     // for updating the SDK and any related configurations.
     npm update paytabs-nodejs-sdk
     or
     yarn upgrade paytabs-nodejs-sdk
*/

console.log('PayTabs Node.js integration setup guide.');
console.log('Refer to the official PayTabs documentation for detailed implementation.');
```

--------------------------------

### Node.js Integration Setup

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/NodeJS-Setup-Activate-and-Upgrade-the-integration-method

This section details the initial setup for integrating PayTabs into a Node.js backend. It emphasizes the use of server-to-server API calls and recommends HTTP client agents for managing requests.

```Node.js
/*
  This guide covers the basics for integrating with PayTabs APIs.
  All requests are made using server-to-server calls with JSON format data.
  Requests MUST NOT be used through a browser.
  Use any HTTP client agent like cURL, Postman, Rest client, etc.
*/

// Example of a conceptual API request (not actual code):
// fetch('https://api.paytabs.com/payment/request', {
//   method: 'POST',
//   headers: {
//     'Content-Type': 'application/json',
//     'Authorization': 'Bearer YOUR_API_KEY'
//   },
//   body: JSON.stringify({
//     // payment details
//   })
// })
// .then(response => response.json())
// .then(data => console.log(data))
// .catch(error => console.error('Error:', error));
```

--------------------------------

### Node.js Integration Setup

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages

Instructions for installing and activating the Node.js integration package for PayTabs. Includes system requirements and supported payment methods.

```Node.js
NPM installation steps and activation guide can be found at:
https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/NodeJs-Setup-Activate-and-Upgrade-the-integration-method/Install-and-activate

Supported Node.js versions: Any
Supported Payment Methods: Based on Region, click here to learn more: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/supported-payment-methods
```

--------------------------------

### Node.js Package Management

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/NodeJS-Setup-Activate-and-Upgrade-the-integration-method/Install-and-activate

This section details the process of installing, activating, upgrading, and uninstalling the PayTabs Node.js package. It covers the necessary commands and procedures to manage the integration within your project.

```Node.js
Install the package:
// Command to install the paytabs-node-sdk package
npm install paytabs-node-sdk

Activate the package:
// Example of activating the SDK with your credentials
const paytabs = require('paytabs-node-sdk');
paytabs.init('YOUR_MERCHANT_EMAIL', 'YOUR_SERVER_KEY');

Upgrade the package:
// Command to update the paytabs-node-sdk to the latest version
npm update paytabs-node-sdk

Uninstall the package:
// Command to remove the paytabs-node-sdk from your project
npm uninstall paytabs-node-sdk
```

--------------------------------

### Node.js Package Management

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/NodeJS-Setup-Activate-and-Upgrade-the-integration-method/Upgrade-the-package

Instructions for installing, activating, upgrading, and uninstalling the PayTabs Node.js package. This ensures your integration is up-to-date and functional.

```Node.js
npm install paytabs-nodejs
# or
yarn add paytabs-nodejs
```

```Node.js
// Activation and upgrade commands would typically involve configuration or specific API calls not detailed here.
```

```Node.js
npm uninstall paytabs-nodejs
# or
yarn remove paytabs-nodejs
```

--------------------------------

### Laravel Integration Setup

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages

Instructions for installing and activating the Laravel integration package for PayTabs. Includes system requirements and supported payment methods.

```Laravel
Composer installation steps and activation guide can be found at:
https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/Laravel-Step-1-Setup-and-Activate-Integration-Method/Laravel-Setup-Activate-and-Upgrade-the-integration-method/Install-and-activate

Supported Laravel versions: [5.8 , 8.x]
Supported Payment Methods: Based on Region, click here to learn more: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/Laravel-Step-1-Setup-and-Activate-Integration-Method/supported-payment-methods
```

--------------------------------

### Node.js Integration Setup and Activation

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/system-requirements

Guides on setting up, activating, and upgrading the PayTabs integration method for Node.js applications. Includes system requirements and supported payment methods.

```Node.js
console.log('Node.js integration setup and activation guide.');
// Refer to PayTabs documentation for specific implementation details.
```

--------------------------------

### PayTabs Invoices API - Setup and Initiation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-7-Manage-Transactions/Invoices-Step-7-Landing

This section covers the initial steps for PayTabs Invoices integration, including setup, activation, configuration, and initiating payments.

```APIDOC
Step 1 - Setup and Activate the Integration Method:
  Description: Details on how to set up and activate the invoice integration method.
  Content: Provides guidance on initial configuration and activation steps.

Step 2 - Configure the integration method:
  Description: Configuration steps for the invoice integration method.
  Content: Information on setting up payment parameters and options.

Step 3 - Initiating the payment:
  Description: Process for initiating a payment through an invoice.
  Content: Details on creating and sending invoices for payment.
```

--------------------------------

### Node.js Integration Setup and Activation

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/supported-payment-methods

Guides on setting up, activating, and upgrading the PayTabs integration method for Node.js applications. Covers system requirements and supported payment methods.

```Node.js
console.log('Node.js integration setup and activation guide available.');
// Refer to: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/
```

--------------------------------

### PayTabs Hosted Payment Page (HPP) Integration

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-1-Setup-and-Activate-Integration-Method/Setup%2C%20Activate%20and%20Upgrade%20the%20integration%20method

Guides through the process of integrating with PayTabs Hosted Payment Page (HPP). Covers setup, activation, configuration, payment initiation, acceptance, response handling, and transaction management.

```APIDOC
APIDOC:
  PayTabs Hosted Payment Page (HPP) Integration:
    - Step 1: Setup and Activate the Integration Method
      - PCI Requirements
      - System Requirements
      - Setup, Activate and Upgrade the integration method
    - Step 2: Configure the integration method
    - Step 3: Initiating the payment
    - Step 4: Accepting the payment
    - Step 5: Handle the payment response
    - Step 6: Handle Post-Payment Response
    - Step 7: Manage Transactions
    - Supported Features & Payment Methods
```

--------------------------------

### PayTabs Hosted Payment Page (HPP) Integration

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-1-Setup-and-Activate-Integration-Method/System%20Requirements

Guides for integrating with PayTabs Hosted Payment Page (HPP), covering setup, activation, configuration, payment initiation, acceptance, response handling, and transaction management.

```APIDOC
HPP Integration Steps:

1.  **Step 1: Setup and Activate the Integration Method**
    *   PCI Requirements
    *   System Requirements
    *   Setup, Activate and Upgrade the integration method

2.  **Step 2: Configure the integration method**

3.  **Step 3: Initiating the payment**

4.  **Step 4: Accepting the payment**

5.  **Step 5: Handle the payment response**

6.  **Step 6: Handle Post-Payment Response**

7.  **Step 7: Manage Transactions**

**Supported Features & Payment Methods**
```

--------------------------------

### PayTabs API Endpoints Overview

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-1-Setup-and-Activate-Integration-Method/System%20Requirements

This section outlines the PayTabs API Endpoints, guiding users through integration types and setup processes. It serves as a central hub for accessing detailed documentation on various payment integration methods.

```APIDOC
PT API Endpoints:
  - Introduction: https://docs.paytabs.com/manuals/PT-API-Endpoints/Introduction
  - Integration Types Manuals:
    - Landing Page: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/-Landing-Page
    - Hosted Payment Page:
      - HPP Landing Page: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Landing-Page
      - Step 1 - Setup and Activate Integration Method: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-1-Setup-and-Activate-Integration-Method/HPP-Step-1-Landing
      - PCI Requirements: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-1-Setup-and-Activate-Integration-Method/Get%20to%20know%20more%20about%20the%20PCI%20requirements
      - Setup, Activate and Upgrade Integration Method: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-1-Setup-and-Activate-Integration-Method/Setup,%20Activate%20and%20Upgrade%20the%20integration%20method
```

--------------------------------

### PayTabs Hosted Payment Page (HPP) Integration

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-1-Setup-and-Activate-Integration-Method/HPP-Step-1-Landing

Guides for integrating with PayTabs Hosted Payment Page (HPP), covering setup, activation, configuration, payment initiation, response handling, and transaction management.

```APIDOC
HPP Integration Steps:

1. Setup and Activate the Integration Method:
   - Get to know More About the PCI Requirements
   - System Requirements
   - Setup, Activate and Upgrade the integration method

2. Configure the integration method

3. Initiating the payment

4. Accepting the payment

5. Handle the payment response

6. Handle Post-Payment Response

7. Manage Transactions

Supported Features & Payment Methods
```

--------------------------------

### Laravel Package Installation and Activation

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-1-Setup-and-Activate-Integration-Method/Laravel-Setup-Activate-and-Upgrade-the-integration-method/Install-and-activate

Instructions for installing and activating the PayTabs payment gateway package in a Laravel application. This typically involves using Composer for installation and then registering the service provider.

```bash
composer require paytabs/paytabs-laravel
php artisan vendor:publish --provider="Paytabs\PaytabsLaravel\PaytabsLaravelServiceProvider"

```

--------------------------------

### Install PayTabs Laravel Package via Composer

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-1-Setup-and-Activate-Integration-Method/Laravel-Setup-Activate-and-Upgrade-the-integration-method/Install-and-activate

Command to install the PayTabs Laravel package using Composer. This command fetches the package and its dependencies.

```bash
composer require Paytabscom/Laravel_paytabs
```

--------------------------------

### PayTabs PayLinks API Documentation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/Paylinks-Step-1-Setup-and-Activate-Integration-Method/Setup%2C%20Activate%20and%20Upgrade%20the%20integration%20method

Documentation for PayTabs PayLinks API, covering setup, activation, configuration, payment initiation, acceptance, response handling, and transaction management.

```APIDOC
PayLinks API:

Overview:
  This section details the PayTabs PayLinks API, a method for creating and managing payment links.

Steps:
  1. Setup and Activate the Integration Method:
     - Get to know more about the PCI requirements.
     - System Requirements.
     - Setup, Activate and Upgrade the integration method.
  2. Configure the integration method.
  3. Initiating the payment.
  4. Accepting the payment.
  5. Handle the payment response.
  6. Handle Post-Payment Response.
  7. Manage Transactions.

Supported Features & Payment Methods:
  - Details on supported features and payment methods for PayLinks.
```

--------------------------------

### PayTabs Invoices API Integration Manual Overview

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-1-Setup-and-Activate-Integration-Method/Invoices-Step-1-Landing

This section provides an overview of the Invoices API integration process, including setup, activation, and the overall 7-step journey to accepting payments. It also references external resources like PCI requirements and system requirements.

```APIDOC
APIDOC:
  title: Invoices API Integration Manual
  description: Guides integration of PayTabs Invoices Payment Page.
  sections:
    - title: Introduction
      content: Provides an overview of API endpoints for payment processing via managed or hosted pages.
    - title: Integration Process
      description: A 7-step process from scratch to accepting payments and handling responses.
      link: https://support.paytabs.com/en/support/solutions/articles/60000719197-paytabs-integrations-process-manual
    - title: Postman Collection
      description: Reference to the PayTabs Postman APIs Collection for interaction.
      link: https://documenter.getpostman.com/view/14575178/TWDRtfWG
    - title: Step 1 - Setup and Activate the Integration Method
      subsections:
        - title: Get to know more about the PCI requirements
          link: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-1-Setup-and-Activate-Integration-Method/Get%20to%20know%20more%20about%20the%20PCI%20requirements
        - title: System Requirements
          link: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-1-Setup-and-Activate-Integration-Method/System%20Requirements
        - title: Setup, Activate and Upgrade the integration method
          link: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-1-Setup-and-Activate-Integration-Method/Setup,%20Activate%20and%20Upgrade%20the%20integration%20method
    - title: Navigation
      previous: The Invoices APIs Integration Manual
      next: Get to know more about the PCI requirements
    - title: Company Information
      description: PayTabs is a payments infrastructure company focused on the MENA region.
```

--------------------------------

### PayTabs PayLinks API Documentation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/Paylinks-Step-1-Setup-and-Activate-Integration-Method/Get%20to%20know%20more%20about%20the%20PCI%20requirements

Documentation for the PayTabs PayLinks API, covering all steps from setup and activation to payment handling and transaction management. Includes details on PCI requirements, system configurations, and supported features.

```APIDOC
PayLinks API:

Step 1 - Setup and Activate the Integration Method:
  - Get to know more about the PCI requirements
  - System Requirements
  - Setup, Activate and Upgrade the integration method

Step 2 - Configure the integration method

Step 3 - Initiating the payment

Step 4 - Accepting the payment

Step 5 - Handle the payment response

Step 6 - Handle Post-Payment Response

Step 7 - Manage Transactions

Supported Features & Payment Methods
```

--------------------------------

### PHP Refund Transaction Example

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-7-Manage-Transactions/Refund-Transaction

Example of how to use the Paytabs API to perform a refund operation in PHP. This snippet demonstrates the required parameters and function call.

```PHP
$tran_ref="TST2016700000692";
$order_id="cart_11111";
$refund_description="Void reason of the items/services."
$amount=500.00;

$refund=Paypage::void($tran_ref,$order_id,$amount,$refund_description);
return$refund;
```

--------------------------------

### PayTabs Invoice Setup and Configuration API

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-7-Manage-Transactions/Invoices-Step-7-Edit-Invoice

Guides for setting up and activating invoice integration methods, and configuring integration parameters. Covers initial setup, activation, and method configuration for PayTabs invoices.

```APIDOC
Step 1 - Setup and Activate the Integration Method:
  Description: Details the process of setting up and activating the invoice integration method with PayTabs.

Step 2 - Configure the integration method:
  Description: Provides instructions on configuring the parameters and settings for the activated invoice integration method.
```

--------------------------------

### PayTabs Invoices API - Step 1: Setup and Activate Integration

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-1-Setup-and-Activate-Integration-Method/Get%20to%20know%20more%20about%20the%20PCI%20requirements

Details on setting up, activating, and upgrading the integration method for PayTabs Invoices API, including PCI requirements and system prerequisites.

```APIDOC
APIDOC:
  Endpoint: /invoices/setup-activate-integration
  Method: POST
  Description: Configures and activates the invoice integration method.
  Parameters:
    - api_key (string, required): Your PayTabs API key.
    - integration_method (string, required): Specifies 'invoices'.
    - pci_compliance (boolean, optional): Indicates PCI compliance status.
    - system_requirements (object, optional): Details on system prerequisites.
  Responses:
    - 200 OK: Successfully configured.
    - 400 Bad Request: Invalid parameters.
  Related Commands:
    - Setup, Activate and Upgrade the integration method
    - Get to know more about the PCI requirements
    - System Requirements
```

--------------------------------

### PayTabs API Endpoints Overview

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/NodeJS-Setup-Activate-and-Upgrade-the-integration-method

Provides an overview of the available PayTabs API endpoints for backend integrations. This is a reference for understanding the different functionalities offered by the PayTabs API.

```APIDOC
PT API Endpoints:
  - Introduction: https://docs.paytabs.com/manuals/PT-API-Endpoints/Introduction
  - (Further details on specific endpoints would be listed here if available in the source text)
```

--------------------------------

### PayTabs Supported Features & Services Documentation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/Paylinks-Step-1-Setup-and-Activate-Integration-Method/Setup%2C%20Activate%20and%20Upgrade%20the%20integration%20method

Documentation outlining the supported features and services offered by PayTabs.

```APIDOC
Supported Features & Services:

Overview:
  A list and description of features and services supported by PayTabs.
```

--------------------------------

### PayTabs Invoices API - Step 3: Initiating Payment

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-1-Setup-and-Activate-Integration-Method/Get%20to%20know%20more%20about%20the%20PCI%20requirements

Details on how to initiate a payment using the PayTabs Invoices API.

```APIDOC
APIDOC:
  Endpoint: /invoices/initiate-payment
  Method: POST
  Description: Initiates a payment transaction for an invoice.
  Parameters:
    - api_key (string, required): Your PayTabs API key.
    - invoice_id (string, required): The ID of the invoice to pay.
    - customer_details (object, required): Information about the customer.
    - payment_details (object, required): Details of the payment method.
  Responses:
    - 201 Created: Payment initiated successfully.
    - 400 Bad Request: Missing required payment information.
```

--------------------------------

### Laravel Package Management

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-1-Setup-and-Activate-Integration-Method/Laravel-Setup-Activate-and-Upgrade-the-integration-method/Upgrade-the-package

Guides for installing, upgrading, and uninstalling the PayTabs package in a Laravel project. These steps are crucial for setting up the payment integration.

```PHP
composer require paytabs/paytabs-laravel
php artisan vendor:publish --provider="Paytabs\PaytabsLaravel\PaytabsLaravelServiceProvider"
php artisan migrate
php artisan config:cache
```

```PHP
composer update paytabs/paytabs-laravel
php artisan vendor:publish --provider="Paytabs\PaytabsLaravel\PaytabsLaravelServiceProvider" --force
php artisan config:cache
```

```PHP
composer remove paytabs/paytabs-laravel
php artisan cache:clear
```

--------------------------------

### PayTabs API Endpoints Overview

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/Paylinks-Step-1-Setup-and-Activate-Integration-Method/System%20Requirements

This section provides an introduction to the PayTabs API Endpoints, guiding developers on how to integrate with PayTabs services.

```APIDOC
PT API Endpoints:
  URL: https://docs.paytabs.com/manuals/PT-API-Endpoints/Introduction
  Description: Provides an introduction to the PayTabs API Endpoints, covering integration and usage.

Integration Types Manuals:
  URL: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/-Landing-Page
  Description: Details various integration types available for PayTabs services.

PayLinks APIs:
  URL: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/PayLinks-Landing-Page
  Description: Specific documentation for PayLinks APIs, enabling payment link creation and management.

Paylinks Step 1 - Setup and Activate Integration Method:
  URL: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/Paylinks-Step-1-Setup-and-Activate-Integration-Method/PayLinks-Step-1-Landing
  Description: Guides through the initial setup and activation process for PayLinks integration.
  Related: Get to know more about the PCI requirements, Setup, Activate and Upgrade the integration method.
```

--------------------------------

### PayTabs PayLinks API Documentation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/Paylinks-Step-1-Setup-and-Activate-Integration-Method/PayLinks-Step-1-Landing

Comprehensive documentation for PayTabs PayLinks API, covering all steps from setup and activation to payment response handling and transaction management. Includes details on PCI requirements, system requirements, and supported features.

```APIDOC
PayLinks API:

Overview:
  The PayLinks API allows merchants to create and manage payment links for various integration scenarios.

Steps:
  1. Setup and Activate the Integration Method:
     - Get to know more about the PCI requirements.
     - System Requirements.
     - Setup, Activate and Upgrade the integration method.
  2. Configure the integration method.
  3. Initiating the payment.
  4. Accepting the payment.
  5. Handle the payment response.
  6. Handle Post-Payment Response.
  7. Manage Transactions.

Supported Features & Payment Methods:
  - Details on supported features and payment methods available through PayLinks.
```

--------------------------------

### PayTabs Invoices API Documentation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-1-Setup-and-Activate-Integration-Method/Setup%2C%20Activate%20and%20Upgrade%20the%20integration%20method

Documentation for the PayTabs Invoices API, covering the entire lifecycle of invoice creation, payment initiation, and transaction management. Includes steps for setup, activation, configuration, payment acceptance, response handling, and post-payment management.

```APIDOC
Invoices API Documentation:

Step 1 - Setup and Activate the Integration Method:
  - Get to know more about the PCI requirements
  - System Requirements
  - Setup, Activate and Upgrade the integration method

Step 2 - Configure the integration method

Step 3 - Initiating the payment

Step 4 - Accepting the payment

Step 5 - Handle the payment response

Step 6 - Handle Post-Payment Response

Step 7 - Manage Transactions

Supported Features & Payment Methods
```

--------------------------------

### Node.js Package Management

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/NodeJs/NodeJs-Step-1-Setup-and-Activate-Integration-Method/NodeJS-Setup-Activate-and-Upgrade-the-integration-method/Uninstall-the-package

Instructions for installing, activating, upgrading, and uninstalling the PayTabs Node.js package. This covers the lifecycle of the integration package within a Node.js project.

```Node.js
npm install paytabs-nodejs
# or
yarn add paytabs-nodejs
```

```Node.js
# To activate the package, follow the setup instructions in the documentation.
# This typically involves configuration within your application.
```

```Node.js
npm update paytabs-nodejs
# or
yarn upgrade paytabs-nodejs
```

```Node.js
npm uninstall paytabs-nodejs
# or
yarn remove paytabs-nodejs
```

--------------------------------

### PayTabs API Endpoints Overview

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/Laravel-Step-3-Initiating-the-payment/Initiating-The-Payment/manage-the-transaction-type-sendtransaction

Provides an introduction to the PayTabs API Endpoints, serving as a starting point for developers interacting with the PayTabs payment gateway services.

```APIDOC
PT API Endpoints:
  https://docs.paytabs.com/manuals/PT-API-Endpoints/
```

--------------------------------

### Download Invoice Request Example

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-7-Manage-Transactions/Invoices-Step-7-Downloading-Invoice

This cURL command demonstrates how to make a GET request to the PayTabs API to download an invoice. It includes the endpoint URL and an authorization header.

```curl
curl --location --request GET 'https://secure.paytabs.com/payment/invoice/123456/download/pdf' \
--header 'Authorization: SGJNBXXXXX-J6RNNXXXXX-2ZGWLXXXXX'
```

--------------------------------

### PayTabs Managed Form APIs Integration

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Managed-Form/Managed-Form-Step-1-Setup-and-Activate-Integration-Method/Managed-Form-Step-One-Landing

This section outlines the PayTabs Managed Form Payment Page API integration process. It covers the overall 7-step journey from initial setup to handling payment responses, emphasizing the use of PayTabs endpoints and providing links to essential resources like PCI requirements and system setup guides.

```APIDOC
APIDOC:
  Title: PayTabs Managed Form APIs Integration Manual
  Description: Guides integration of PayTabs Managed Form Payment Page PT API Endpoints.
  Process Overview:
    - A 7-step process from scratch to accepting payments and handling responses.
    - Relies on PayTabs endpoints Postman collection.
  Key Resources:
    - PCI Requirements: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Managed-Form/Managed-Form-Step-1-Setup-and-Activate-Integration-Method/Get%20to%20know%20more%20about%20the%20PCI%20requirements
    - System Requirements: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Managed-Form/Managed-Form-Step-1-Setup-and-Activate-Integration-Method/System%20Requirements
    - Setup, Activate and Upgrade: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Managed-Form/Managed-Form-Step-1-Setup-and-Activate-Integration-Method/Setup,%20Activate%20and%20Upgrade%20the%20integration%20method
    - Postman Collection: https://documenter.getpostman.com/view/14575178/TWDRtfWG
  Navigation:
    - Previous: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Managed-Form/Managed-Form-Landing-Page
    - Next: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Managed-Form/Managed-Form-Step-1-Setup-and-Activate-Integration-Method/Get%20to%20know%20more%20about%20the%20PCI%20requirements
```

--------------------------------

### PayTabs PayLinks API Documentation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/Paylinks-Step-1-Setup-and-Activate-Integration-Method/System%20Requirements

Comprehensive documentation for PayTabs PayLinks API, covering all steps from setup to transaction management. Includes details on integration methods, payment handling, and response processing.

```APIDOC
PayLinks API Documentation:

Step 1 - Setup and Activate the Integration Method:
  - Get to know more about the PCI requirements
  - System Requirements
  - Setup, Activate and Upgrade the integration method

Step 2 - Configure the integration method

Step 3 - Initiating the payment

Step 4 - Accepting the payment

Step 5 - Handle the payment response

Step 6 - Handle Post-Payment Response

Step 7 - Manage Transactions

Supported Features & Payment Methods
```

--------------------------------

### Invoice Initiation Response - Redirect URL

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-3-Initiating-Payment/Invoices-Send-Invoices

This snippet shows an example of a redirect URL received when initiating an invoice request. This URL is used to guide the customer to the payment page.

```json
{
  "redirect_url":"https://secure.paytabs.com/payment/page/59946B********************B4817FD4488"
}
```

--------------------------------

### PayTabs Invoices API Documentation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-1-Setup-and-Activate-Integration-Method/System%20Requirements

Documentation for PayTabs Invoices API, covering setup, activation, configuration, payment initiation, acceptance, response handling, and transaction management.

```APIDOC
Invoices API:

Overview:
This section details the PayTabs Invoices API, guiding users through the process of setting up, activating, configuring, and managing invoice-based payments.

Key Steps:
1.  **Setup and Activate the Integration Method**: Covers PCI requirements, system requirements, and the process of setting up, activating, and upgrading the integration method.
2.  **Configure the integration method**: Details the configuration steps for the invoice integration.
3.  **Initiating the payment**: Explains how to start a payment process using invoices.
4.  **Accepting the payment**: Describes the process of accepting a payment.
5.  **Handle the payment response**: Details how to process the immediate response after a payment attempt.
6.  **Handle Post-Payment Response**: Covers the handling of responses that occur after the initial payment.
7.  **Manage Transactions**: Provides information on managing transactions related to invoices.

Supported Features & Payment Methods:
Details the features and payment methods supported by the Invoices API.
```

--------------------------------

### PayTabs Managed Form Integration

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Managed-Form/Managed-Form-Supported-Features-%26-Payment-Methods/Managed-Form-Supported-Features/Own-Form-Supported-Features-Landing

Guides for integrating with PayTabs Managed Form, covering setup, configuration, payment initiation, acceptance, response handling, and transaction management.

```APIDOC
Managed Form Integration Steps:

1. Setup and Activate the Integration Method:
   - Details on how to set up and activate the Managed Form integration.

2. Configure the Integration Method:
   - Configuration parameters and options for the Managed Form.

3. Initiating the Payment:
   - Steps and API calls to initiate a payment using the Managed Form.

4. Accepting the Payment:
   - How to accept payments through the Managed Form.

5. Handle the Payment Response:
   - Processing and handling responses after a payment attempt.

6. Handle Post-Payment Response:
   - Managing responses and actions after a payment is completed.

7. Manage Transactions:
   - Operations for managing transactions made via the Managed Form.
```

--------------------------------

### PayTabs API Endpoints Overview

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-1-Setup-and-Activate-Integration-Method/Setup%2C%20Activate%20and%20Upgrade%20the%20integration%20method

Provides an overview of the PayTabs API endpoints, including various integration types and their specific documentation.

```APIDOC
APIDOC:
  PT API Endpoints:
    - Integration Types Manuals:
      - Hosted Payment Page
      - Invoices
      - PayLinks
      - Managed Form
      - Own Form
      - Request & Response Parameters
      - APMs Direct Payment Methods
      - Supported Features & Services
    - Repeat Billing & Agreements
    - Token-Based Transactions
```

--------------------------------

### Laravel Payment Lifecycle

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/Laravel-Step-3-Initiating-the-payment/Initiating-The-Payment/manage-the-transaction-type-sendtransaction

Covers the essential steps in the Laravel payment process, from initial setup and configuration to accepting payments, handling responses, and managing transactions post-payment.

```Laravel
// Step 1 - Setup and Activate the Integration Method
// https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-1-Setup-and-Activate-Integration-Method/

// Step 2 - Configure the integration method
// https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/Laravel-Configure-the-integration-method

// Step 3 - Initiating the payment
// https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/Laravel-Step-3-Initiating-the-payment/laravel-Step-3-Landing

// Step 4 - Accepting the payment
// https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/accepting-the-payment

// Step 5 - Handle the payment response
// https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/Handle-the-payment-response

// Step 6 - Handle the post-payment responses (notifications)
// https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/handle-the-post-payment-responses-notifications

// Step 7 - Manage Transactions
// https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-7-Manage-Transactions/
```

--------------------------------

### Laravel Integration Setup and Activation

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-1-Setup-and-Activate-Integration-Method/supported-payment-methods

Guides on setting up, activating, and upgrading the PayTabs integration method within a Laravel project. Covers system requirements and supported payment methods.

```Laravel
composer require paytabs/paytabs-laravel

php artisan vendor:publish --provider="Paytabs\PaytabsLaravel\PaytabsLaravelServiceProvider"

// Configure .env file with PayTabs credentials
```

--------------------------------

### PayTabs Request & Response Parameters Documentation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/PayLinks-APIs/Paylinks-Step-1-Setup-and-Activate-Integration-Method/Setup%2C%20Activate%20and%20Upgrade%20the%20integration%20method

Documentation detailing request and response parameters for PayTabs API integrations.

```APIDOC
Request & Response Parameters:

Overview:
  Details on the parameters used in PayTabs API requests and responses.
```

--------------------------------

### PayTabs Hosted Payment Page (HPP) Integration

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-5-handle-the-payment-response/HPP-Step-5-Landing

Guides for integrating with PayTabs Hosted Payment Page (HPP), covering setup, configuration, payment initiation, handling responses, and transaction management.

```APIDOC
APIDOC:
  title: Hosted Payment Page (HPP) Integration
  description: Guides for integrating with PayTabs Hosted Payment Page (HPP), covering setup, configuration, payment initiation, handling responses, and transaction management.
  sections:
    - title: Step 1 - Setup and Activate the Integration Method
      description: Details on how to set up and activate the HPP integration method.
      url: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-1-Setup-and-Activate-Integration-Method/HPP-Step-1-Landing
    - title: Step 2 - Configure the integration method
      description: Instructions for configuring the HPP integration method.
      url: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-2-Configure-Integration-Method/HPP-Step-2-Landing
    - title: Step 3 - Initiating the payment
      description: How to initiate a payment using the HPP.
      url: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-3-Initiating-Payment/HPP-Step-3-Landing
    - title: Step 4 - Accepting the payment
      description: Information on accepting payments via HPP.
      url: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-4-Accepting-the-payment/HPP-Step-4-Landing
    - title: Step 5 - Handle the payment response
      description: Guidance on handling payment responses from HPP.
      url: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-5-handle-the-payment-response/HPP-Step-5-Landing
    - title: Step 6 - Handle Post-Payment Response
      description: How to manage post-payment responses from HPP.
      url: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-6-Handle-post-payment-responses/HPP-Step-Six-Landing
    - title: Step 7 - Manage Transactions
      description: Procedures for managing transactions made through HPP.
      url: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Step-7-Manage-Transactions/HPP-Step-7-Landing
    - title: Supported Features & Payment Methods
      description: Overview of features and payment methods supported by HPP.
      url: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Supported-Features-&-Payment-Methods/HPP-Supported-Features-&-Payment-Methods-Landing
```

--------------------------------

### PayTabs Invoice API - Setup and Initiation

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Invoices-APIs/Invoices-Step-7-Manage-Transactions/Invoices-Step-7-Retrieve-Invoice-Details

This section covers the initial steps for integrating with PayTabs Invoices, including setting up and activating the integration method, configuring it, and initiating a payment.

```APIDOC
APIDOC:
  Endpoint: /v1/invoices

  Methods:
    Setup and Activate Integration Method:
      POST /activate
      Description: Activates the invoice integration method for your account.
      Parameters:
        - merchant_id (string, required): Your PayTabs merchant ID.
        - integration_type (string, required): Specifies the integration type (e.g., 'invoices').
      Returns:
        - Activation status and credentials.

    Configure Integration Method:
      PUT /configure/{integration_id}
      Description: Configures settings for an activated integration method.
      Parameters:
        - integration_id (string, required): The ID of the integration method to configure.
        - configuration_details (object, required): Object containing configuration parameters.
      Returns:
        - Configuration success message.

    Initiate Payment:
      POST /initiate
      Description: Initiates a new invoice payment process.
      Parameters:
        - invoice_details (object, required): Object containing invoice details (amount, currency, customer info, etc.).
        - integration_id (string, required): The ID of the integration method to use.
      Returns:
        - Payment URL or redirect information.
```

--------------------------------

### PayTabs API Endpoints Overview

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/Laravel-Step-3-Initiating-the-payment/Initiating-The-Payment/initiate-an-iframedembedded-payment-page-sendframed

This documentation block provides an overview of the available PayTabs API endpoints for backend integrations. It serves as a starting point for understanding the different functionalities offered by the API.

```APIDOC
PT API Endpoints:
  - Introduction: Overview of available API endpoints.
  - Backend Web-Packages: Documentation for server-side integrations.
    - Laravel: Specific guides for Laravel framework integration.
```

--------------------------------

### Laravel Refund Transaction Implementation

Source: https://docs.paytabs.com/manuals/Backend-Web-Packages/Laravel/laravel-Step-7-Manage-Transactions/Refund-Transaction

Example of how to implement the refund transaction functionality within a Laravel application using the PayTabs backend package. This involves calling the appropriate methods to process the refund.

```PHP
// Assuming you have initialized the PayTabs integration class
// and have the necessary transaction details (e.g., transaction ID)

// Example placeholder for the refund process
// Replace with actual PayTabs SDK method calls

$transactionIdToRefund = 'your_transaction_id';
$refundAmount = 100.50; // Amount to refund

// Call the refund method provided by the PayTabs Laravel package
// $response = $paytabs->refundTransaction($transactionIdToRefund, $refundAmount);

// Process the response
// if ($response->isSuccessful()) {
//     echo 'Refund successful!';
// } else {
//     echo 'Refund failed: ' . $response->getErrorMessage();
// }
```

--------------------------------

### PayTabs Hosted Payment Page (HPP) Integration

Source: https://docs.paytabs.com/manuals/PT-API-Endpoints/Integration-Types-Manuals/Hosted-Payment-Page/HPP-Supported-Features-%26-Payment-Methods/HPP-Supported-Features/HPP-Supported-Features-Landing

Guides for integrating with PayTabs Hosted Payment Page (HPP). Covers setup, configuration, payment initiation, acceptance, response handling, and transaction management.

```APIDOC
Hosted Payment Page (HPP) Integration:

Step 1 - Setup and Activate the Integration Method:
  - Details on how to set up and activate the HPP integration.

Step 2 - Configure the integration method:
  - Configuration parameters and options for HPP.

Step 3 - Initiating the payment:
  - Process for initiating a payment transaction via HPP.

Step 4 - Accepting the payment:
  - How to accept payments through the HPP.

Step 5 - Handle the payment response:
  - Handling responses after a payment is processed.

Step 6 - Handle Post-Payment Response:
  - Managing responses that occur after the initial payment.

Step 7 - Manage Transactions:
  - Operations for managing payment transactions.
```