Mobile Money API

Mobile money is provider-orchestrated and must respect country support, operator availability, phone-number format, KYC tier, limits, and provider pricing.

Endpoints

Endpoint Method Auth Headers Notes
Create mobile money beneficiary
/payment/api/v1/mobile-money/beneficiaries/
Validate and store a mobile money withdrawal or payout destination.
POST User JWT
Authenticated caller
Authorization: Bearer <user-jwt>
Content-Type: application/json
Sandbox: Supported with sandbox keys and adapters.
Production: Available subject to verification, country activation, and provider support.
Rate limits: Standard authenticated rate limits
List mobile money beneficiaries
/payment/api/v1/mobile-money/beneficiaries/
Return stored mobile money destinations for the authenticated user.
GET User JWT
Authenticated caller
Authorization: Bearer <user-jwt>
Content-Type: application/json
Sandbox: Supported with sandbox keys and adapters.
Production: Available subject to verification, country activation, and provider support.
Rate limits: Standard authenticated rate limits
Create mobile money transfer
/payment/api/v1/mobile-money/transfers/
Send funds to a routed mobile money operator.
POST User JWT
Authenticated caller
Authorization: Bearer <user-jwt>
Content-Type: application/json
Status lifecycle: created, pending, processing, successful, failed, reversed, under_review
Sandbox: Supported with sandbox keys and adapters.
Production: Available subject to verification, country activation, and provider support.
Rate limits: Standard authenticated rate limits