Skip to content

Get VA Transaction

Fetch a VA settlement by transaction reference.

MethodGET
URL/api/m1/va-transaction?reference=DVA-999357240831142552459563784150
AuthBearer ZMPRO-… (live) or ZMDEV-… (test)

Query parameters

NameRequiredExampleDescription
referenceYesDVA-999357240831142552459563784150Transaction or VA settlement reference.

Headers

HeaderValue
AuthorizationBearer ZMPRO-your-live-api-key

Request

bash
curl -X GET 'https://api.vizo.app/api/m1/va-transaction?reference=DVA-999357240831142552459563784150' \
  -H 'Authorization: Bearer ZMPRO-your-live-api-key'
ts
const response = await fetch('https://api.vizo.app/api/m1/va-transaction?reference=DVA-999357240831142552459563784150', {
  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/va-transaction?reference=DVA-999357240831142552459563784150"
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/va-transaction?reference=DVA-999357240831142552459563784150');
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

Get Transaction SUCCESS — 200 OK

json
{
  "status": "SUCCESS",
  "data": {
    "id": "DVA-1",
    "tx_ref": "DVA-999357240831142552459563784150",
    "amount": 98.5,
    "charged_amount": 100,
    "app_fee": 1.5,
    "merchant_fee": 0,
    "currency": "NGN",
    "status": "SUCCESSFUL",
    "payment_mode": "DVA",
    "created_at": "2024-08-31T14:25:52.645613",
    "customer": {
      "consumer_id": ""
    },
    "data": {
      "narration": " DOT/3/CR-FROM/John Doe - Test",
      "accountNo": "1000119971",
      "accountName": "John Doe",
      "sourceBankCode": "999357",
      "sourceAccountNo": "1000075721",
      "sourceAccountName": "John Doe John",
      "amount": 98.5,
      "transactionDate": "2024-08-31T14:25:52.645613",
      "totalAmount": 100,
      "fee": 1.5,
      "merchantReference": "",
      "currency": "NGN"
    }
  },
  "message": "SUCCESSFUL"
}

Get Transaction FAILED — 404 Not Found

json
{
  "status": "FAILED",
  "data": null,
  "message": "Transaction not found"
}

ViZO Merchant API documentation