Skip to main content

​
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

Terminal Management

Manage collection points and access terminal profiles

Transaction Processing

Initiate and track collection flows across terminals

Payment Splitting

Create and manage split collections across multiple parties

QR Payments

Generate QR codes for collection and split payment flows

Wallet Credit and Debit

Provision wallets with KYC, move funds, create static and dynamic accounts, and reverse wallet transactions

PayTag Management

Search, resolve, create, and link PayTags to partner-scoped wallets

Webhook Notifications

Receive partner transaction and wallet debit or credit events in real time

​
Base URLs

​
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

Terminal API

Manage collection points, route transactions, and handle splits

Wallet API

Retrieve your partner wallet, provision scoped wallets, view summaries, move funds, create static and dynamic accounts, and reverse wallet transactions

PayTag API

Search ecosystem PayTags, resolve by tag or BVN, link existing profiles, and create partner PayTags

Webhooks

Receive transaction status and wallet debit or credit event notifications

Transactions API

Gateway transaction management, reporting, and wallet credit/debit flows

​
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
Some collection endpoints also require a valid terminal identifier in the request headers.
Wallet retrieval, provisioning, transfer, dynamic account, and transaction reversal endpoints are available under the dedicated Wallet API using partner authentication and, where applicable, a partner wallet reference.
Partners can also configure a webhook URL to receive transaction.status, wallet.debited, and wallet.credited notifications.

​
Quick Start

1

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)
2

Set Up Terminals

Configure your collection terminals and obtain their serial numbers for authentication
3

Test Integration

Start with terminal profile retrieval and a small collection flow
4

Go Live

Deploy to production after testing in staging environment

​
Common Use Cases

POS Integration

Integrate FLEX collections into your point-of-sale system

Wallet Operations

Retrieve your partner wallet and perform institution-scoped provisioning, debit, credit, summary, dynamic account, and reversal operations on linked wallets

PayTag Resolution

Find or create PayTags for customers and bind them into your partner context

Webhook Automation

Automate reconciliation and notifications using partner webhook callbacks

Multi-Location

Manage multiple collection points across different locations

Split Bills

Enable split collections for restaurants and group purchases

Transaction Tracking

Monitor and report on all gateway transactions

​
Support

Need help? Reach out to our developer support team:

​
API Status Codes

​
Next Steps

Terminal API

Explore collection terminal endpoints

Wallet API

Explore scoped wallet operations and refunds

PayTag API

Explore partner PayTag lookup and creation flows

Webhooks

Implement partner event callbacks

Transactions API

Gateway transaction management

OpenAPI Spec

Complete API specification