Introduction

These public endpoints are available to all merchants and require no API key. They list the countries, providers and bank codes supported by HUB2.

List of countries

curl --location --request GET 'https://api.hub2.io/data/countries' \
  --header 'Environment: sandbox' \
  --header 'Content-Type: application/json'

const url = 'https://api.hub2.io/data/countries';
const headers = {
  'Environment': 'sandbox',
  'Content-Type': 'application/json'
};

fetch(url, {
  method: 'GET',
  headers: headers
})
  .then(response => {
    if (!response.ok) {
      throw new Error('Network response was not ok');
    }
    return response.json();
  })
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error('There was a problem with your fetch operation:', error);
  });

import requests

url = 'https://api.hub2.io/data/countries'
headers = {
    'Environment': 'sandbox',
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print('Error:', response.status_code)

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class Main {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://api.hub2.io/data/countries");
            HttpURLConnection connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Environment", "sandbox");
            connection.setRequestProperty("Content-Type", "application/json");

            int responseCode = connection.getResponseCode();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
                String inputLine;
                StringBuffer response = new StringBuffer();

                while ((inputLine = in.readLine()) != null) {
                    response.append(inputLine);
                }
                in.close();

                System.out.println(response.toString());
            } else {
                System.out.println("Error: " + responseCode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

You can filter the countries by payment method with the optional method query parameter (for example ?method=mobile_money).

See the API reference for full details.

Use the country code (BF, SN, etc.) in the country fields of payments and transfers.

List of providers

curl --location --request GET 'https://api.hub2.io/data/providers' \
  --header 'Environment: sandbox' \
  --header 'Content-Type: application/json'

const url = 'https://api.hub2.io/data/providers';
const headers = {
  'Environment': 'sandbox',
  'Content-Type': 'application/json'
};

fetch(url, {
  method: 'GET',
  headers: headers
})
  .then(response => {
    if (!response.ok) {
      throw new Error('Network response was not ok');
    }
    return response.json();
  })
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error('There was a problem with your fetch operation:', error);
  });

import requests

url = 'https://api.hub2.io/data/providers'
headers = {
    'Environment': 'sandbox',
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print('Error:', response.status_code)

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class Main {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://api.hub2.io/data/providers");
            HttpURLConnection connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("GET");
            connection.setRequestProperty("Environment", "sandbox");
            connection.setRequestProperty("Content-Type", "application/json");

            int responseCode = connection.getResponseCode();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
                String inputLine;
                StringBuffer response = new StringBuffer();

                while ((inputLine = in.readLine()) != null) {
                    response.append(inputLine);
                }
                in.close();

                System.out.println(response.toString());
            } else {
                System.out.println("Error: " + responseCode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

You can filter the providers with the optional country, method and names query parameters (for example ?country=CI&method=mobile_money). Only enabled providers are returned. Pass names as a list: ?names[]=mtn or ?names=mtn&names=orange.

See the API reference for full details.

Use the provider name in the provider fields of payments and transfers. This field is case-insensitive.

List of bank codes

The bank codes available for bank transfers, grouped by country, are returned by the bank codes endpoint.

Payout coverage

The providers, countries and destination types available for payouts change over time. GET /data/providers is the source of truth: query it to know what you can use at any given moment instead of relying on a fixed list. Bank transfer payouts are available in Burkina Faso (BF), Benin (BJ), Guinea-Bissau (GW), Mali (ML), Niger (NE), Senegal (SN) and Togo (TG). HUB2 validates the destination account before sending a bank transfer: an account number that does not match the destination country, or whose structure is invalid, makes the transfer fail with the invalid_destination failure cause, and no request is sent to the bank.

Getting started

Transfers

Payments

Instant Payment

Webhooks

Processing Only

Payment Links

Subscriptions

Submerchants

Other

Public data

Introduction

List of countries

List of providers

List of bank codes

Payout coverage

​Introduction

​List of countries

​List of providers

​List of bank codes

​Payout coverage

Introduction

List of countries

List of providers

List of bank codes

Payout coverage