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.

Path Parameters

id
string
required

Body

application/json
amountMinor
number
required

Amount in minor units (XAF/XOF: 1 unit = 1 minor). USD: cents.

Required range: x >= 1
Example:

5000

rail
enum<string>
required
Available options:
BANK_TRANSFER,
MOBILE_MONEY
accountBank
string
required

Bank code or mobile-money network code (MTN, ORANGE, …)

Required string length: 2 - 32
Example:

"MTN"

accountNumber
string
required

Bank account number or mobile money MSISDN

Required string length: 5 - 32
Example:

"237671381152"

beneficiaryName
string
required
Required string length: 2 - 120
Example:

"Joram Abayo"

reference
string

Client idempotency key (server prefixes wallet id)

Maximum string length: 64
narration
string
Maximum string length: 200
Example:

"Campaign payout"

email
string
Maximum string length: 254
Example:

"merchant@example.com"

Response

Withdrawal replay (idempotent)