Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Headers

X-Workspace-Id
string<uuid>

Partner / ISV only: UUID of the workspace that owns the client company. Required together with X-Acting-Company-Id when scoping product APIs to a merchant. See /getting-started/multi-tenancy.

X-Acting-Company-Id
string<uuid>

Partner / ISV only: UUID of the client company to act on. Must belong to the workspace in X-Workspace-Id.

Body

application/json
amount
number
required

Charge amount in major currency units (e.g. 1000 GHS).

Required range: x >= 0.01
Example:

1000

currency
string
required

ISO currency. Maps to charge type when type is omitted (GHS→ghana, UGX→uganda, RWF→rwanda, ZMW→zambia, XAF/XOF→franco).

Example:

"GHS"

email
string<email>
required
Example:

"customer@example.com"

phone_number
string
required

Customer mobile money MSISDN.

Example:

"0551234567"

tx_ref
string

Unique transaction reference (6–42 chars). Generated when omitted.

Required string length: 6 - 42
Example:

"fwmomo-org123-a1b2c3d4"

type
enum<string>

Charge type query param. Inferred from currency when omitted.

Available options:
mobile_money_ghana,
mobile_money_uganda,
mobile_money_rwanda,
mobile_money_zambia,
mobile_money_franco
network
string

Required for Ghana, Uganda, and Zambia (e.g. MTN, VODAFONE, AIRTEL).

Example:

"MTN"

country
string

ISO 3166-1 alpha-2 country. Required for Francophone (XAF/XOF).

Required string length: 2
Example:

"CM"

voucher
string

Required for Uganda mobile money.

Example:

"128373"

order_id
string

Required for Rwanda and Zambia. Generated when omitted for those corridors.

Example:

"ORD_MM_1585323540079"

fullname
string
Example:

"Jane Doe"

redirect_url
string

Optional redirect after customer completes authorization.

Example:

"https://app.example.com/pay/return"

meta
object
Example:
client_ip
string
Example:

"154.123.220.1"

device_fingerprint
string
Example:

"62wd23423rq324323qew1"

Response

Mobile money collection initiated

success
boolean
required

Whether the request succeeded

Example:

true

message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

data
object

Endpoint-specific payload