Skip to main content
POST
/
api
/
v1
/
payments
/
billing
/
checkout
/
mobile-money
cURL
curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/payments/billing/checkout/mobile-money" \
  -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \
  -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \
  -H "X-Fluide-Client-Id: fluide-developer" \
  -H "X-Workspace-Id: $FLUIDE_WORKSPACE_ID" \
  -H "X-Acting-Company-Id: $FLUIDE_COMPANY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

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
​
countryCode
string
required

Mobile money country calling code (digits only).

Pattern: /^\d{1,4}$/
Example:

"233"

​
network
string
required

Mobile money network identifier.

Example:

"MTN"

​
phoneNumber
string
required

Mobile money phone number (digits only).

Pattern: /^\d{6,15}$/
Example:

"9012345678"

​
plan
enum<string>

Used to create billing row if missing.

Available options:
flex,
starter,
business,
growth,
enterprise
​
scenarioKey
string

Optional Flutterwave scenario key for sandbox testing.

Example:

"scenario:auth_pin&issuer:approved"

​
redirectUrl
string<uri>

Absolute redirect URL Flutterwave sends the user back to after authorization.

Example:

"http://localhost:3000/billing/return"

​
debug
boolean

When true, include sanitized Flutterwave request/response payloads for debugging.

Example:

true

​
discountCode
string

Optional discount code (platform-managed)

Maximum string length: 64

Response

Mobile money checkout session

​
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