Single Payout

Disburse to one destination

To send money to a single bank account or mobile money wallet, you need a single API. This process requires an active balance where the funds are debited then sent.

Setup an Active Balance for your payouts here

Disburse - Single

POST https://staging.moneywaveapp.com/v1/disburse

Destination and transfer details are passed for processing.

Headers

Name	Type	Description
Autohrization	string	Authorization Token

Request Body

Name	Type	Description
cashpickup	boolean	Enable cash pickup option for USD
x_routing_number	string	Routing Number. Required for USD ( pass the destination bank code here )
x_recipient_address	string	Required for USD
x_recipient_country	string	Required for USD
countryTag	string	Tag ie SN for Senegal and required by XOF and XAF currencies only
x_recipient_email	string	Required for USD, ZAR
x_recipient_phone	string	Required for USD, ZAR
x_recipient_name	string	Required for all except NGN - beneficiary name
branchCode	string	Required for GHS - Bank's Branch code
walletUref	string	Specify the balance to use as source
narration	string	Description to appear in bank statement
ref	string	Unique transaction tracking reference
amount	number	Amount to send
currency	string	Currency of Amount to send
bankcode	string	Destination Bank or Mobile code
accountNumber	string	Beneficiary Account Number
senderName	string	Sender / Business Name to appear in bank statement
lock	string	Password required to access active balance (wallet)

200 Disburse processing response returned. The response code is key to determining transaction status.

{
  "status": "success",
  "data": {
    "data": {
      "responsecode": "00",
      "responsemessage": "Approved Or Completed Successfully",
      "uniquereference": "TMW000000317"
    },
    "status": "success"
  } 
}

Sample Code

Select a Language above ...

Node.JS

var unirest = require("unirest");
var base_url = "https://staging.moneywaveapp.com";
var req = unirest("POST", `${base_url}/v1/disburse`);

req.headers({
  "Authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwibmFtZSI6IlRocml2ZSIsImFjY291bnROdW1iZXIiOiIwNjkwMDAwMDAiLCJiYW5rQ29kZSI6IjMwNyIsImlzQWN0aXZlIjp0cnVlLCJlbnZpcm9ubWVudCI6ImxpdmUiLCJjYW5fZ29saXZlIjp0cnVlLCJjb3VudGRvd24iOm51bGwsImNvbXBsaWFuY2UiOjgsImNvZGUiOiJNTDU4MCIsInBvc0lkIjoiMTE0NjMiLCJlYmlsbElkIjoiTVRGVyIsImlwIjpudWxsLCJjcmVhdGVkQXQiOiIyMDE2LTA5LTE2VDEzOjQ5OjIzLjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDE3LTA3LTE5VDE0OjA2OjM2LjAwMFoiLCJkZWxldGVkQXQiOm51bGwsImlhdCI6MTUzMDIxMTc4MiwiZXhwIjoxNTMwMjE4OTgyfQ.gQDK03I9Jc0dO21RxsZjG0k4Px0NzTk4tRnkbV5VciU",
  "Content-Type": "application/json"
});
req.type("json");
req.send({
	"ref": "SD252849857",
	"amount": "525000",
	"currency": "NGN",
	"bankcode": "044",
	"accountNumber": "0600000004",
	"senderName": "ABCompany",
	"lock": "walpassword",
	"narration": "Equipments",
});

req.end(function (res) {
  if (res.error) console.log(res.code, res.body);
  else console.log(res.body);
});

PHP

<?php

$curl = curl_init();
$base_url = "https://staging.moneywaveapp.com";
$header = array(
  "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwibmFtZSI6IlRocml2ZSIsImFjY291bnROdW1iZXIiOiIwNjkwMDAwMDAiLCJiYW5rQ29kZSI6IjMwNyIsImlzQWN0aXZlIjp0cnVlLCJlbnZpcm9ubWVudCI6ImxpdmUiLCJjYW5fZ29saXZlIjp0cnVlLCJjb3VudGRvd24iOm51bGwsImNvbXBsaWFuY2UiOjgsImNvZGUiOiJNTDU4MCIsInBvc0lkIjoiMTE0NjMiLCJlYmlsbElkIjoiTVRGVyIsImlwIjpudWxsLCJjcmVhdGVkQXQiOiIyMDE2LTA5LTE2VDEzOjQ5OjIzLjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDE3LTA3LTE5VDE0OjA2OjM2LjAwMFoiLCJkZWxldGVkQXQiOm51bGwsImlhdCI6MTUzMDIxMDY4MywiZXhwIjoxNTMwMjE3ODgzfQ.IO4iX_estdWbe2dHey27bj5xsZC0skXHGdFUMTQSJfI",
  "Content-Type: application/json",
);

$body = array(
  "ref" => "SD252849857",
  "amount" => "525000",
  "currency" => "NGN",
  "bankcode" => "044",
  "accountNumber" => "0600000004",
  "senderName" => "ABCompany",
  "lock" => "walpassword",
  "narration" => "Equipments",
);

curl_setopt_array($curl, array(
  CURLOPT_URL => $base_url . "/v1/disburse",
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 180,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_POSTFIELDS => json_encode($body),
  CURLOPT_HTTPHEADER => $header,
));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);


if ($err) {
  echo "cURL Error #:" . $err;
} else {
  $decodedResponse = json_decode($response, true);

  echo "<pre>"; print_r($decodedResponse);
}

The ref passed must be unique to prevent double disbursements to the same beneficiary. Preferably the ref used should match a unique customer action, for example a loan ID, settlement ID or charge / payment reference.

For Mobile Money payouts such as M-pesa in Kenya or MTN in Ghana, pass the beneficiary mobile number as account Number and use the code returned from banks list as bank code.

Increase timeout settings in your http client to 180 seconds. This ensures you receive an expected response for payouts with long processing times.

Confirming Success

After a disburse request is received via API, it is submitted for processing. When completed a response is returned. See the example response in the API snippet above.

A disbursement is successful only when the disburse API response has the value below.

"responsecode" : "00"

In a scenario where an unexpected response or no response was received. Due to connection delay or http timeout or error. Do not assume success or fail. Check Disburse status here.

KES and GHS currency payouts are asynchronous and would return a response code of 02 indicating Transaction Processing. To receive notification when completed see here

Recipient's name is also required for payouts in these currencies and should be passed as x_recipient_name along with other parameters in the request body.