Skip to content

Get Transfer

Get the status and details of a previously initiated transfer.

MethodGET
URL/api/m1/transfer
AuthBearer ZMPRO-… (live) or ZMDEV-… (test)

Query parameters

FieldRequiredExampleDescription
zp_refYesZWB-R31ra4EKVoObViZO transfer reference.

Headers

HeaderValue
AuthorizationBearer ZMPRO-your-live-api-key

Request

bash
curl -X GET 'https://api.vizo.app/api/m1/transfer?zp_ref=ZWB-R31ra4EKVoOb' \
  -H 'Authorization: Bearer ZMPRO-your-live-api-key'
ts
const response = await fetch('https://api.vizo.app/api/m1/transfer?zp_ref=ZWB-R31ra4EKVoOb', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer ZMPRO-your-live-api-key',
  },
});

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

url = "https://api.vizo.app/api/m1/transfer?zp_ref=ZWB-R31ra4EKVoOb"
headers = {
    "Authorization": "Bearer ZMPRO-your-live-api-key",
}

response = requests.request("GET", url, headers=headers)
print(response.status_code)
print(response.json())
php
<?php

$ch = curl_init('https://api.vizo.app/api/m1/transfer?zp_ref=ZWB-R31ra4EKVoOb');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ZMPRO-your-live-api-key',
    ],
]);

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

echo $status, PHP_EOL, $response, PHP_EOL;

Responses

Successful Quote Stage — 200 OK

json
{
  "status": "SUCCESS",
  "data": {
    "zp_ref": "ZWB-PwJulOJBvK8B",
    "which_balance": "GHS",
    "account_number": "ZTF-10515",
    "beneficiary_name": "Test",
    "amount": 10,
    "exchange_rate": 94.22347,
    "exchange_amount": 942.23,
    "fee": "0.25",
    "reference": "ZWB-PwJulOJBvK8B",
    "tx": null,
    "currency": "NGN",
    "country": "GH",
    "transfer_mode": "SMART",
    "transfer_status": "INITIATED",
    "transfer_date": null,
    "transfer_detail": "Transfer narration detail"
  },
  "message": "Success"
}

Successful Executed/Completed Stage — 200 OK

json
{
  "status": "SUCCESS",
  "data": {
    "transfer_id": 10045,
    "which_balance": "GHS",
    "account_number": "ZTF-10515",
    "beneficiary_name": "Test",
    "amount": 10,
    "exchange_rate": 94.22347,
    "exchange_amount": 942.23,
    "fee": "0.25",
    "reference": "ZWB-PwJulOJBvK8B",
    "tx": "txt-hash-here",
    "currency": "NGN",
    "country": "GH",
    "transfer_mode": "SMART",
    "transfer_status": "COMPLETED",
    "transfer_date": "2026-07-17T18:10:20Z",
    "transfer_detail": "Transfer narration detail",
    "zp_ref": "ZWB-PwJulOJBvK8B"
  },
  "message": "Success"
}

ViZO Merchant API documentation