Get Bank Transfer Form

Bank-transfer form schema for a currency corridor.

Method	GET
URL	/api/m1/transfer-form?currency_code=ng
Auth	Bearer ZMPRO-… (live) or ZMDEV-… (test)

Query parameters

Name	Required	Example	Description
currency_code	—	ng	Corridor currency code.

Headers

Header	Value
Authorization	Bearer ZMPRO-your-live-api-key

Request

cURL

curl -X GET 'https://api.vizo.app/api/m1/transfer-form?currency_code=ng' \
  -H 'Authorization: Bearer ZMPRO-your-live-api-key'

TypeScript

const response = await fetch('https://api.vizo.app/api/m1/transfer-form?currency_code=ng', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer ZMPRO-your-live-api-key',
  },
});

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

Python

import requests

url = "https://api.vizo.app/api/m1/transfer-form?currency_code=ng"
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-form?currency_code=ng');
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 Bank Transfer Form — 200 OK

{
  "status": "SUCCESS",
  "data": {
    "select": [
      {
        "value": "dc",
        "label": "Domiciliary Account"
      },
      {
        "value": "fdc",
        "label": "FCMB Domiciliary Account"
      }
    ],
    "meta": {
      "dc": [
        {
          "value": "first_name",
          "label": "First Name",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "last_name",
          "label": "Last Name",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "email",
          "label": "Receiver Email",
          "require": true,
          "input_type": "email"
        },
        {
          "value": "beneficiary_country",
          "label": "Beneficiary Country Code",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "mobile_number",
          "label": "Mobile Number",
          "require": true,
          "input_type": "tel"
        },
        {
          "value": "sender",
          "label": "Sender Name",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "merchant_name",
          "label": "Merchant Name",
          "require": false,
          "input_type": "text"
        }
      ],
      "fdc": [
        {
          "value": "first_name",
          "label": "First Name",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "last_name",
          "label": "Last Name",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "email",
          "label": "Receiver Email",
          "require": true,
          "input_type": "email"
        },
        {
          "value": "beneficiary_country",
          "label": "Beneficiary Country Code",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "mobile_number",
          "label": "Mobile Number",
          "require": true,
          "input_type": "tel"
        },
        {
          "value": "sender",
          "label": "Sender Name",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "merchant_name",
          "label": "Merchant Name",
          "require": false,
          "input_type": "text"
        },
        {
          "value": "beneficiary_occupation",
          "label": "Beneficiary Occupation",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "recipient_address",
          "label": "Recipient Address",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "email",
          "label": "Receiver Email",
          "require": true,
          "input_type": "email"
        },
        {
          "value": "sender",
          "label": "Sender Name",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "sender_country",
          "label": "Sender Country Code",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "sender_id_number",
          "label": "Sender ID Number",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "sender_id_type",
          "label": "Sender ID Type",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "sender_id_expiry",
          "label": "Sender ID Expiry Date",
          "require": true,
          "input_type": "date"
        },
        {
          "value": "sender_mobile_number",
          "label": "Sender Mobile Number",
          "require": true,
          "input_type": "tel"
        },
        {
          "value": "sender_address",
          "label": "Sender Address",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "sender_occupation",
          "label": "Sender Occupation",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "sender_beneficiary_relationship",
          "label": "Sender Beneficiary Relationship",
          "require": true,
          "input_type": "text"
        },
        {
          "value": "transfer_purpose",
          "label": "Transfer Purpose",
          "require": true,
          "input_type": "text"
        }
      ]
    }
  },
  "message": "Success"
}