> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yourflexpay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Collect money into Flex Wallet with the FLEX Partner gateway API

## Welcome to FLEX Partner API

The FLEX Partner API is a payment gateway for partners who need to collect money from users into Flex Wallet.
Participating applications initiate and confirm transactions through the gateway, while Flex handles routing, tracking, and settlement.

## What You Can Do

<CardGroup cols={2}>
  <Card title="Terminal Management" icon="cash-register">
    Manage collection points and access terminal profiles
  </Card>

  <Card title="Transaction Processing" icon="money-bill-transfer">
    Initiate and track collection flows across terminals
  </Card>

  <Card title="Payment Splitting" icon="hand-holding-dollar">
    Create and manage split collections across multiple parties
  </Card>

  <Card title="QR Payments" icon="qrcode">
    Generate QR codes for collection and split payment flows
  </Card>
</CardGroup>

## Base URLs

<CodeGroup>
  ```bash Staging theme={null}
  https://staging-api.yourflexpay.com/v2
  ```

  ```bash Production theme={null}
  https://api.yourflexpay.com/v2
  ```
</CodeGroup>

## Key Features

### 🏪 Terminal Operations

Dedicated collection endpoints for point-of-sale and wallet-funded payment collection with complete transaction tracking.

### 💸 Split Payments

Advanced payment splitting functionality to distribute collected funds across multiple recipients.

### 📱 QR Code Integration

Generate dynamic QR codes for both regular collection flows and split payment scenarios.

### 🔐 Secure Authentication

All API requests are authenticated using partner credentials with support for terminal-specific collection operations.

## API Sections

<CardGroup cols={2}>
  <Card title="Terminal API" icon="cash-register" href="/partner/terminal">
    Manage collection points, route transactions, and handle splits
  </Card>

  <Card title="Transactions API" icon="exchange" href="/partner/transactions">
    Gateway transaction management and reporting
  </Card>
</CardGroup>

## Authentication

All Partner API endpoints require authentication using your partner credentials:

* **x-client-id**: Your partner client ID
* **x-api-key**: Your partner API key

<Note>
  Some collection endpoints also require a valid terminal identifier in the request headers.
</Note>

## Quick Start

<Steps>
  <Step title="Get API Credentials">
    Contact FLEX support to receive your partner credentials:

    * Client ID (`x-client-id`)
    * API Key (`x-api-key`)
    * Terminal serial numbers (if applicable)
  </Step>

  <Step title="Set Up Terminals">
    Configure your collection terminals and obtain their serial numbers for authentication
  </Step>

  <Step title="Test Integration">
    Start with terminal profile retrieval and a small collection flow
  </Step>

  <Step title="Go Live">
    Deploy to production after testing in staging environment
  </Step>
</Steps>

## Common Use Cases

<CardGroup cols={2}>
  <Card title="POS Integration" icon="cash-register">
    Integrate FLEX collections into your point-of-sale system
  </Card>

  <Card title="Multi-Location" icon="store">
    Manage multiple collection points across different locations
  </Card>

  <Card title="Split Bills" icon="receipt">
    Enable split collections for restaurants and group purchases
  </Card>

  <Card title="Transaction Tracking" icon="chart-line">
    Monitor and report on all gateway transactions
  </Card>
</CardGroup>

## Support

Need help? Reach out to our developer support team:

* **Email**: [developers@yourflexpay.com](mailto:developers@yourflexpay.com)

## API Status Codes

| Status Code | Description                        |
| ----------- | ---------------------------------- |
| `200`       | Success                            |
| `400`       | Bad Request - Invalid parameters   |
| `401`       | Unauthorized - Invalid credentials |
| `404`       | Not Found - Resource doesn't exist |
| `500`       | Server Error - Contact support     |

## Next Steps

<CardGroup cols={2}>
  <Card title="Terminal API" icon="cash-register" href="/partner/terminal">
    Explore collection terminal endpoints
  </Card>

  <Card title="Transactions API" icon="exchange" href="/partner/transactions">
    Gateway transaction management
  </Card>

  <Card title="OpenAPI Spec" icon="file-code" href="/openapi/partner.openapi.json">
    Complete API specification
  </Card>
</CardGroup>