Skip to main content
This section documents Fingo Pay’s REST API. Use the interactive playground to test requests against https://api.fingopay.io with your API key.

Authentication

All API endpoints use Bearer authentication. Provide your API key as a Bearer token in the Authorization header.
Authorization: Bearer <YOUR_SECRET_KEY>
For POST endpoints, include an Idempotency-Key header so retries do not create duplicate operations.

Enterprise-only fields in API requests

Some endpoints accept optional fields that are only relevant for enterprise integrations (aggregators, dedicated shortcodes, sub-merchants). These fields are marked with the ENTERPRISE badge throughout this reference.
Send only required fields unless your integration needs enterprise routing behavior. Over-specifying optional fields is a common source of integration errors.
EndpointEnterprise-only fieldsNotes
POST /v1/mpesa/chargeshortcode subMerchantId metadata.subMerchantDetailsRoute charges via dedicated shortcode and optional sub-merchant enrichment
POST /v1/mpesa/b2cshortcode subMerchantId metadata.subMerchantDetailsDedicated payout routing with optional sub-merchant enrichment
POST /v1/mpesa/b2bshortcode subMerchantId metadata.subMerchantDetailsDedicated payout routing with optional sub-merchant enrichment

Enterprise integration guide

Learn how to set up dedicated shortcodes, sub-merchants, and enterprise routing patterns.

OpenAPI specification

Fingo Pay OpenAPI

View the source OpenAPI file used by this reference