Get Available Banks · Payouts API

GEThttps://payoutsapi.ozow.com/v1/getavailablebanksProduction

Build with AI 1 package

A build package is every page for one task, with the API operations they use. Copy the prompt into a coding assistant, or hand it the package itself: slim links to each page, full inlines all of them in one document.

Send a payoutEverything needed to pay money out to a customer's bank account or voucher with the Payouts API, including how to exercise the failure paths before going live.
View package

This method can be called to retrieve the set of banks that are available for making payouts to.

The call returns a list of banks with a unique identifier (BankGroupId) per bank. The BankGroupId is utilised as an input parameter to check payout availability for a particular bank, as well as to identify the destination bank for a payout.

Authentication

API key in the ApiKey header

Query parameters

rtconly boolean
For RTC Banks only you can add the "rtconly" parameter to return a filtered list.

Header parameters

SiteCode string required
A unique code for the site currently in use. A site code is generated when adding a site in the Ozow merchant admin section. [Please contact support for SiteCode - support@ozow.com]
max length50
exampleYOUR_SITE_CODE

Responses

200 OK

array of BankGroup

Guides

Send a payoutTransfer funds to a recipient's bank account with the Payouts API. There is no customer-facing step, so the whole integration lives in your backend.

Request

curl -X GET 'https://payoutsapi.ozow.com/v1/getavailablebanks' \
  -H 'ApiKey: YOUR_API_KEY' \
  -H 'SiteCode: YOUR_SITE_CODE'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://payoutsapi.ozow.com/v1/getavailablebanks");
request.Headers.Add("ApiKey", "YOUR_API_KEY");
request.Headers.Add("SiteCode", "YOUR_SITE_CODE");

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

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://payoutsapi.ozow.com/v1/getavailablebanks',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'ApiKey: YOUR_API_KEY',
        'SiteCode: YOUR_SITE_CODE',
    ],
]);

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

const response = await fetch("https://payoutsapi.ozow.com/v1/getavailablebanks", {
  method: "GET",
  headers: {
    "ApiKey": "YOUR_API_KEY",
    "SiteCode": "YOUR_SITE_CODE",
  },
});

const data = await response.json();

import requests

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

response = requests.get(
    "https://payoutsapi.ozow.com/v1/getavailablebanks",
    headers=headers,
)

curl -X GET 'https://payoutsapi.ozow.com/v1/getavailablebanks?rtconly=true' \
  -H 'ApiKey: YOUR_API_KEY' \
  -H 'SiteCode: YOUR_SITE_CODE'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://payoutsapi.ozow.com/v1/getavailablebanks?rtconly=true");
request.Headers.Add("ApiKey", "YOUR_API_KEY");
request.Headers.Add("SiteCode", "YOUR_SITE_CODE");

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

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://payoutsapi.ozow.com/v1/getavailablebanks?rtconly=true',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'ApiKey: YOUR_API_KEY',
        'SiteCode: YOUR_SITE_CODE',
    ],
]);

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

const response = await fetch("https://payoutsapi.ozow.com/v1/getavailablebanks?rtconly=true", {
  method: "GET",
  headers: {
    "ApiKey": "YOUR_API_KEY",
    "SiteCode": "YOUR_SITE_CODE",
  },
});

const data = await response.json();

import requests

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

response = requests.get(
    "https://payoutsapi.ozow.com/v1/getavailablebanks?rtconly=true",
    headers=headers,
)

Response

[
  {
    "bankGroupId": "00000000-0000-0000-0000-000000000000",
    "bankGroupName": "<bankGroupName>",
    "universalBranchCode": "<universalBranchCode>"
  }
]

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

Bad Request. The request did not reach the API. A required header or query parameter is missing, or the body does not match the expected shape.

{
  "message": "<message>"
}

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

Forbidden. The `SiteCode` and `ApiKey` pair was not accepted.

{
  "message": "<message>"
}

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

Internal Server Error. The gateway could not reach the service or the integration failed. A failure inside the service is not this one. Those come back as a 200 with the reason in the payload, because the gateway maps every integration response it has no other rule for onto 200.

{
  "message": "<message>"
}

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