Pull from mobile money

Charges the user's mobile money wallet and credits their account account_id. The payer approves the charge on their phone, so the request is accepted with IN_PROGRESS and settles asynchronously; the final status is delivered via the transfer webhook. Supported for Ghana (GHS) mobile money numbers only. Authenticated user is taken from session or user-uuid header.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

Destination account UUID owned by the authenticated user.

string
required
^\+233\d{9}$

Payer's mobile money number in international format, including the leading +.

number
required
> 0

Amount to charge, in currency.

string
enum
required
Allowed:
uuid

Optional client-generated transfer identifier. Generated when omitted and returned in the response.

Headers
string
length ≤ 255

Unique key per request, e.g. a UUID v4. A retry with the same key and the same body returns the original response with the Idempotent-Replayed: true header and does not run the request again. The same key with a different body returns 422 IdempotencyKeyMismatch; a retry while the first request is still running returns 409 IdempotencyInProgress. Keys are scoped to the authenticated caller and kept for 24 hours. Recommended on every retry of a request that moves money. Max 255 characters.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json