Mobile Money Transfers

This section covers the parameters needed to process payments to mobile money wallets. Bank account transfers follow the same basic format: make a POST request to our Payout API. However, depending on the type of beneficiary and the account's currency, you might need to give some extra information. 

To view all currencies supported for mobile money transfers, please view the supported currencies page

Common Details

So first, let's go through the basic information needed for any account. You'll need to provide these details.

FieldMandatoryTypeDescription
businessYesStringThe ID of the business making the payout.
sourceCurrencyYesStringThe currency which is used to fund the payout
destinationCurrencyYesStringThe currency in which the recipient will be receiving funds
amountYesStringThe value that is to be transferred from the source currency wallet.
descriptionYesStringThis is the type of account you want to send your payments to, see payment destinations for more details
paymentDestinationYesStringThis is the type of account you want to send your payments to, see payment destinations for more details
customerReferenceNoStringThe transaction's unique identifier on your system. Customer references prevent duplicate transactions. We advice that you add it to your payload
quoteReferenceNoStringThis is the reference generated when the source currency is compared against the destination currency.

This is required when the source currency is not the same as the destination currency. You can generate a quote using the Generate quote endpoint.

In addition to the common details needed to process successful payments, the following fields are also required when sending money to a mobile money wallet.

FieldMandatoryTypeDescription
beneficiaryYesObjectThe recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different.
beneficiary.firstNameYesStringThe first name of the beneficiary .
beneficiary.lastNameYesStringThe last name of the beneficiary
beneficiary.phoneNoStringThe mobile number of the beneficiary
beneficiary.accountHolderNameYesStringThis field is required by all type of beneficiaries.
beneficiary.typeYesStringThe type of beneficiary, see beneficiary types for more details
beneficiary.countryYesStringThe country in which the bank of the beneficiary is located. This field should be in ISO 3166-1 alpha-2 codes e.g NG, GB
beneficiary.emailNoStringThe beneficiary's email
beneficiary.mobileMoneyCodeYesStringThis value is the mobile money wallet provider's code. You must use the List bank endpoint to obtain this value.
beneficiary.bankCodeYesStringThe beneficiary bank code. To get the bank code please see the list banks endpoint codes for more details.

The payload should look like this :

{
    "business": "{{The business ID}}",
    "sourceCurrency": "KES",
    "destinationCurrency": "KES",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "KE",
        "phone": "0803443433",
        "mobileMoneyCode": "
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "GHS",
    "destinationCurrency": "GHS",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "XOF",
    "destinationCurrency": "XOF",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "MWK",
    "destinationCurrency": "MWK",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "XAF",
    "destinationCurrency": "XAF",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "BIL",
    "destinationCurrency": "BIL",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "ETB",
    "destinationCurrency": "ETB",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "GMB",
    "destinationCurrency": "GMB",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "TZS",
    "destinationCurrency": "TZS",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "UGX",
    "destinationCurrency": "UGX",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "ZMW",
    "destinationCurrency": "ZMW",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "MAD",
    "destinationCurrency": "MAD",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}
{
    "business": "{{The business ID}}",
    "sourceCurrency": "SZL",
    "destinationCurrency": "SZL",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "mobile_money_wallet",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}