Skip to main content
POST
Request a disbursement

Authorizations

x-api-key
string
header
required

API key for authentication. Generate this from your Mobipurse dashboard under Settings → API Keys.

Body

application/json
reference
string
required

Unique merchant reference for the disbursement. Must be unique for each disbursement.

Example:

"2a59004d-72a9-4bdc-9893-abff8fa6ffb4"

amount
integer
required

The amount to disburse in the lowest currency denomination (e.g., 10000 for 100.00)

Required range: x >= 1
Example:

10000

phoneNumber
string
required

Recipient's phone number in international format without the + sign

Pattern: ^[0-9]{10,15}$
Example:

"2257038102473"

country
string
required

The 2-character ISO country code

Pattern: ^[A-Z]{2}$
Example:

"CI"

currency
string
required

The 3-character ISO currency code

Pattern: ^[A-Z]{3}$
Example:

"XOF"

webhookURL
string<uri>

URL to receive webhook notifications for disbursement events

Example:

"https://webhook.site/100ebe83-961d-4096-8741-05772dafcfa1"

Response

Disbursement created successfully

statusCode
integer
Example:

200

data
object