Payouts

This endpoint is a universal endpoint, below are schemas for different payouts such as mobile money or bank accounts and this endpoint allows you to payout to these destinations through this single endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
⚠️

Production IP policy: If your account has an active IP allowlist, this request must originate from an allowed IPv4 address. A rejected request returns HTTP 400 with errorCode: "IP_NOT_ALLOWED". See IP Allowlisting.

{
    "amount": 100,
    "currency": "KES",
    "country": "KE",
     "externalReference": "test",
    "payoutMethod": {
        "accountName": "John Doe",
        "accountNumber": "254719624552",
	      "code": "OperatorId"
    },
    "destination": "MoMo" 
}

{
    "amount": 100,
    "currency": "KES",
    "country": "KE",
    "externalReference": "test",
    "payoutMethod": {
        "accountName": "John Doe",
        "accountNumber": "1280179878793",
        "code": "1243"
    },
    "destination": "Bank Account" 
}

{
    "amount": 100,
    "currency": "KES",
    "country": "KE",
     "externalReference": "test",
    "payoutMethod": {
        "accountName": "John Doe",
        "accountNumber": "12345677890",
        "businessNumber": "123456"
    },
    "destination": "Paybill" 
}

{
    "amount": 100,
    "currency": "KES",
    "country": "KE",
     "externalReference": "test",
    "payoutMethod": {
        "accountName": "John Doe",
        "accountNumber": "123456"
    },
    "destination": "Till"
}

{
    "amount": 100,
    "externalReference": "1234",
    "externalAccountId": "zxEFheZW6DlnCgXJIJDz"
}

debitCountry is required whenever debitCurrency is XOF, including same-currency payouts; it is optional for other debit currencies, including USD. Omit it when debitCurrency is absent.


{
    "amount": 100,
    "currency": "KES",
    "country": "KE",
    "externalReference": "test",
    "debitCurrency": "USD",
    "debitCountry": "US",
    "payoutMethod": {
        "accountName": "John Doe",
        "accountNumber": "254712345678"
    },
    "destination": "MoMo"
}
Body Params
int32
required
Defaults to 100
string
Defaults to KES
string
Defaults to KE

ISO 3166-1 alpha-2 country code

payoutMethod
object
string
Defaults to MoMo

MoMo / Bank Account

string
required

A unique ID of your liking to reconcile transactions internally.

string
string

The wallet you want to be debited from. If missing, we will default to the currency passed.

string
length between 2 and 2

Country scope of the wallet being debited. Required whenever debitCurrency is XOF, even for same-currency payouts. Optional for other debit currencies, including USD; omit when debitCurrency is absent.

Responses

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