Sign in

v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Send Money

Initiate Send Money Request

Initiate or load a new send money request.

post/api/v1/send-money/initiate/

Request body

currency'KES' | 'GHS' | 'NGN' | 'UGX' | 'TZS' | 'XAF' | 'XOF' | 'USD' | 'CDF' | 'RWF' required

Supported currencies:

  • KES - Kenyan Shilling (KE)
  • GHS - Ghanaian Cedi (GH)
  • NGN - Nigerian Naira (NG)
  • UGX - Ugandan Shilling (UG)
  • TZS - Tanzanian Shilling (TZ)
  • XAF - Central African CFA Franc (CM)
  • XOF - West African CFA Franc (BF, CI)
provider'MPESA-B2C' | 'MPESA-B2B' | 'PESALINK' | 'INTASEND' | 'INTASEND-XB' | 'INTASEND-XB-BANK' | 'AIRTIME' required
device_idstring
callback_urlstring uri nullable
batch_referencestring nullable
country'BF' | 'CM' | 'GH' | 'CI' | 'UG' | 'NG' | 'KE' | 'TZ'

Supported disbursement countries:

  • KE - Kenya (KES)
  • GH - Ghana (GHS)
  • NG - Nigeria (NGN)
  • UG - Uganda (UGX)
  • TZ - Tanzania (TZS)
  • CM - Cameroon (XAF)
  • BF - Burkina Faso (XOF)
  • CI - Ivory Coast (XOF)
requires_approval'NO' | 'YES'

Set this to NO for straight through processing

Example request

{
  "country": "KE",
  "requires_approval": "YES"
}

Response

file_idstring required
device_idstring required
tracking_idstring uuid
batch_referencestring nullable
statusstring required
status_codestring required
noncestring
charge_estimatestring required
total_amount_estimatestring required
total_amountstring required
transactions_countstring required
created_atstring date-time nullable required
updated_atstring date-time nullable required