Get Banking Details · Payments API

GEThttps://api.ozow.com/secure/banktransfer/bankingdetailsProduction

The Ozow account to deposit into for a reference created earlier, and the reference the deposit must carry.

Authentication

API key in the ApiKey header
The unique API key for the merchant. See Prerequisites and onboarding for where to find it.

Query parameters

siteCode string required
A unique code for the each of the merchant's sites. A site code is generated when adding a site in the Ozow merchant admin section.
max length50
exampleTST-MER-001
bankReference string required
The reference returned by Create Unique Reference or Create Static Reference.
max length20
exampleDEPOSIT-001

Responses

200 OK

bankName string required
Name of the bank the account is held at.
max length50
branchCode string required
The destination branch code for the account
max length10
accountNumber string required
The Ozow account number to use for deposit
max length20
publicRecipientName string
The name of the public recipient if applicable (depending whether a bankId was passed in the original request)
max length50
beneficiaryReference string required
The reference to be used for the deposit
max length20

401 Unauthorized. The ApiKey header is missing or does not match the site, or for a Secure operation the bearer token is missing, expired or invalid.

string

example 1

API key is missing or invalid.

Request

curl -X GET 'https://api.ozow.com/secure/banktransfer/bankingdetails?siteCode=TST-MER-001&bankReference=DEPOSIT-001' \
  -H 'ApiKey: YOUR_API_KEY'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://api.ozow.com/secure/banktransfer/bankingdetails?siteCode=TST-MER-001&bankReference=DEPOSIT-001");
request.Headers.Add("ApiKey", "YOUR_API_KEY");

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.ozow.com/secure/banktransfer/bankingdetails?siteCode=TST-MER-001&bankReference=DEPOSIT-001',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'ApiKey: YOUR_API_KEY',
    ],
]);

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

const response = await fetch("https://api.ozow.com/secure/banktransfer/bankingdetails?siteCode=TST-MER-001&bankReference=DEPOSIT-001", {
  method: "GET",
  headers: {
    "ApiKey": "YOUR_API_KEY",
  },
});

const data = await response.json();

import requests

headers = {
    "ApiKey": "YOUR_API_KEY",
}

response = requests.get(
    "https://api.ozow.com/secure/banktransfer/bankingdetails?siteCode=TST-MER-001&bankReference=DEPOSIT-001",
    headers=headers,
)

Response

{
  "bankName": "<bankName>",
  "branchCode": "000000",
  "accountNumber": "0000000000",
  "publicRecipientName": "<publicRecipientName>",
  "beneficiaryReference": "<beneficiaryReference>"
}

Built from the response schema. Values are placeholders, not real data.

Bad Request. The operation could not be carried out. The body is a message rather than a structured error.

There was an error processing your request

Unauthorized. The `ApiKey` header is missing or does not match the site, or for a `Secure` operation the bearer token is missing, expired or invalid.

API key is missing or invalid.