GHS, UGX, ZMW & TZS Account

Quote a GHS / UGX / ZMW / TZS bank payout.

Method	POST
URL	/api/m1/initiate-transfer
Auth	Bearer ZMPRO-… (live) or ZMDEV-… (test)

Body parameters

Field	Required	Example	Description
which_balance	Yes	NGN	String which currency to debited
account	Yes	0031625807099	String receive account or account number
destination_branch_code	—	GH280103	—
account_bank	—	GH280100	—
account_name	Yes	John Doe	String receive account name
beneficiary_name	Yes	John Doe	String receive account name
amount	Yes	1000	Amount to charge or transfer.
transfer_mode	Yes	bank	String transfer method (smart, bank or crypto)
currency	Yes	GHS	ISO currency code (e.g. NGN, USD).
narration	—	food	This is the narration for the transfer e.g. payments for food
callback_url	—	https://dev.zupago.app:8086/test-dev/ccccc	This will replace Webhooks url
reference	Yes	MCH-11011	Transaction or VA settlement reference.

Headers

Header	Value
Authorization	Bearer ZMPRO-your-live-api-key
Content-Type	application/json

Request

cURL

curl -X POST 'https://api.vizo.app/api/m1/initiate-transfer' \
  -H 'Authorization: Bearer ZMPRO-your-live-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
  "which_balance": "NGN",
  "account": "0031625807099",
  "destination_branch_code": "GH280103",
  "account_bank": "GH280100",
  "account_name": "John Doe",
  "beneficiary_name": "John Doe",
  "amount": 1000,
  "transfer_mode": "bank",
  "currency": "GHS",
  "narration": "food",
  "callback_url": "https://dev.zupago.app:8086/test-dev/ccccc",
  "reference": "MCH-11011"
}'

TypeScript

const response = await fetch('https://api.vizo.app/api/m1/initiate-transfer', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer ZMPRO-your-live-api-key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "which_balance": "NGN",
  "account": "0031625807099",
  "destination_branch_code": "GH280103",
  "account_bank": "GH280100",
  "account_name": "John Doe",
  "beneficiary_name": "John Doe",
  "amount": 1000,
  "transfer_mode": "bank",
  "currency": "GHS",
  "narration": "food",
  "callback_url": "https://dev.zupago.app:8086/test-dev/ccccc",
  "reference": "MCH-11011"
}),
});

const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.vizo.app/api/m1/initiate-transfer"
headers = {
    "Authorization": "Bearer ZMPRO-your-live-api-key",
    "Content-Type": "application/json",
}
payload = {
  "which_balance": "NGN",
  "account": "0031625807099",
  "destination_branch_code": "GH280103",
  "account_bank": "GH280100",
  "account_name": "John Doe",
  "beneficiary_name": "John Doe",
  "amount": 1000,
  "transfer_mode": "bank",
  "currency": "GHS",
  "narration": "food",
  "callback_url": "https://dev.zupago.app:8086/test-dev/ccccc",
  "reference": "MCH-11011"
}

response = requests.request("POST", url, headers=headers, json=payload)
print(response.status_code)
print(response.json())

PHP

<?php

$ch = curl_init('https://api.vizo.app/api/m1/initiate-transfer');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ZMPRO-your-live-api-key',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'which_balance' => 'NGN',
        'account' => '0031625807099',
        'destination_branch_code' => 'GH280103',
        'account_bank' => 'GH280100',
        'account_name' => 'John Doe',
        'beneficiary_name' => 'John Doe',
        'amount' => 1000,
        'transfer_mode' => 'bank',
        'currency' => 'GHS',
        'narration' => 'food',
        'callback_url' => 'https://dev.zupago.app:8086/test-dev/ccccc',
        'reference' => 'MCH-11011'
    ], JSON_UNESCAPED_SLASHES),
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status, PHP_EOL, $response, PHP_EOL;

Responses

GHS, UGX, ZMW & TZS Account — 200 OK

{
  "status": "SUCCESS",
  "data": {
    "which_balance": "NGN",
    "amount": 1000,
    "account_name": "John Doe",
    "exchange_rate": 94.22347171,
    "exchange_amount": 10.61,
    "account": "0031625807099",
    "currency": "GHS",
    "zp_ref": "ZWB-CtXiVMqVNB7K",
    "fee": 2072.91,
    "expires_in": "2022-09-06T13:18:31.151837Z"
  },
  "message": "Success"
}