Skip to content

Overview

The PayHero Africa API lets you collect and disburse money across Africa over mobile money (MoMo), bank and card rails, through a single unified endpoint.

Base URL

The production base URL is https://api.payhero.africa. All requests are made against this host (referred to as BACKEND_URL_V2 in the Postman collection).

Authentication

Every authenticated endpoint uses HTTP Basic authentication. Generate an API key (username + password) from your PayHero dashboard, then send them as the Basic credentials:

Authorization: Basic base64(<API_USERNAME>:<API_PASSWORD>)

Your credentials map to the Postman variables X-PH-API-USERNAME and X-PH-API-PASSWORD.

Callbacks

Final transaction results are delivered asynchronously to the callback_url you provide on each request. See the Callbacks section for the payload shape.

The unified Payments endpoint

POST /api/global/payments handles both collections (pay-in) and disbursements (pay-out). The request_type field selects the direction:

request_type Direction Description
payment Pay-in Collect money from a customer
withdrawal Pay-out Send money to a recipient

The same request shape works across countries (KE, TZ, ZM, BW, NG, …) — you change currency, country, and the provider/network details.

Information

  • OpenAPI version: 3.1.0

HTTP Basic auth using the API username (X-PH-API-USERNAME) and password (X-PH-API-PASSWORD) generated from your PayHero dashboard.

Security scheme type: http