GHS Payments

Use GHS for Ghana payment requests and account verification requests.

Currency Value

GHS

Retrieve Ghana Institutions

curl --request GET \
  --url https://backendapi.sayswitchgroup.com/api/v1/bank_list/GHS \
  --header "Authorization: Bearer YOUR_SECRET_KEY" \
  --header "Accept: application/json"

// Run secret-key requests on your server.
const response = await fetch("https://backendapi.sayswitchgroup.com/api/v1/bank_list/GHS", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Accept": "application/json"
  }
});
 
const responseBody = await response.text();
console.log(response.status, responseBody);

<?php
$request = curl_init('https://backendapi.sayswitchgroup.com/api/v1/bank_list/GHS');
 
curl_setopt_array($request, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
        'Accept: application/json',
    ],
]);
 
$responseBody = curl_exec($request);
$status = curl_getinfo($request, CURLINFO_HTTP_CODE);
curl_close($request);
 
echo $status . PHP_EOL;
echo $responseBody;

from urllib.request import Request, urlopen
 
request = Request(
    "https://backendapi.sayswitchgroup.com/api/v1/bank_list/GHS",
    method="GET",
    headers={
        "Authorization": "Bearer YOUR_SECRET_KEY",
        "Accept": "application/json",
    },
)
 
with urlopen(request) as response:
    response_body = response.read().decode()
    print(response.status, response_body)

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
var request = HttpRequest.newBuilder()
    .uri(URI.create("https://backendapi.sayswitchgroup.com/api/v1/bank_list/GHS"))
    .header("Authorization", "Bearer YOUR_SECRET_KEY")
    .header("Accept", "application/json")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
 
var response = HttpClient.newHttpClient().send(
    request,
    HttpResponse.BodyHandlers.ofString()
);
 
System.out.println(response.statusCode());
System.out.println(response.body());

Account Verification

Pass GHS as the currency when verifying a Ghana bank account or mobile money number.

curl --request POST \
  --url https://backendapi.sayswitchgroup.com/api/v1/account_name_verify \
  --header "Authorization: Bearer YOUR_SECRET_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "bank_code": "MTNGH",
    "account_number": "233000000000",
    "currency": "GHS"
  }'

// Run secret-key requests on your server.
const response = await fetch("https://backendapi.sayswitchgroup.com/api/v1/account_name_verify", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "bank_code": "MTNGH",
    "account_number": "233000000000",
    "currency": "GHS"
  })
});
 
const responseBody = await response.text();
console.log(response.status, responseBody);

<?php
$request = curl_init('https://backendapi.sayswitchgroup.com/api/v1/account_name_verify');
 
curl_setopt_array($request, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{
    "bank_code": "MTNGH",
    "account_number": "233000000000",
    "currency": "GHS"
  }',
]);
 
$responseBody = curl_exec($request);
$status = curl_getinfo($request, CURLINFO_HTTP_CODE);
curl_close($request);
 
echo $status . PHP_EOL;
echo $responseBody;

from urllib.request import Request, urlopen
 
payload = "{\n    \"bank_code\": \"MTNGH\",\n    \"account_number\": \"233000000000\",\n    \"currency\": \"GHS\"\n  }".encode()
 
request = Request(
    "https://backendapi.sayswitchgroup.com/api/v1/account_name_verify",
    data=payload,
    method="POST",
    headers={
        "Authorization": "Bearer YOUR_SECRET_KEY",
        "Content-Type": "application/json",
    },
)
 
with urlopen(request) as response:
    response_body = response.read().decode()
    print(response.status, response_body)

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
var body = """
    {
        "bank_code": "MTNGH",
        "account_number": "233000000000",
        "currency": "GHS"
      }
    """;
 
var request = HttpRequest.newBuilder()
    .uri(URI.create("https://backendapi.sayswitchgroup.com/api/v1/account_name_verify"))
    .header("Authorization", "Bearer YOUR_SECRET_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(body))
    .build();
 
var response = HttpClient.newHttpClient().send(
    request,
    HttpResponse.BodyHandlers.ofString()
);
 
System.out.println(response.statusCode());
System.out.println(response.body());

Payment Request

Pass GHS as the currency when initiating a Ghana bank or mobile money payment.

curl --request POST \
  --url https://backendapi.sayswitchgroup.com/api/v1/bank_transfer \
  --header "Authorization: Bearer YOUR_SECRET_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "account_name": "John Doe",
    "account_number": "0245690993",
    "amount": "10",
    "bank_code": "MTNGH",
    "bank_name": "MTNGH",
    "currency": "GHS",
    "narration": "Test transfer",
    "reference": "UNIQUE_TRANSACTION_REFERENCE",
    "paymentMode": "momo"
  }'

// Run secret-key requests on your server.
const response = await fetch("https://backendapi.sayswitchgroup.com/api/v1/bank_transfer", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "account_name": "John Doe",
    "account_number": "0245690993",
    "amount": "10",
    "bank_code": "MTNGH",
    "bank_name": "MTNGH",
    "currency": "GHS",
    "narration": "Test transfer",
    "reference": "UNIQUE_TRANSACTION_REFERENCE",
    "paymentMode": "momo"
  })
});
 
const responseBody = await response.text();
console.log(response.status, responseBody);

<?php
$request = curl_init('https://backendapi.sayswitchgroup.com/api/v1/bank_transfer');
 
curl_setopt_array($request, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{
    "account_name": "John Doe",
    "account_number": "0245690993",
    "amount": "10",
    "bank_code": "MTNGH",
    "bank_name": "MTNGH",
    "currency": "GHS",
    "narration": "Test transfer",
    "reference": "UNIQUE_TRANSACTION_REFERENCE",
    "paymentMode": "momo"
  }',
]);
 
$responseBody = curl_exec($request);
$status = curl_getinfo($request, CURLINFO_HTTP_CODE);
curl_close($request);
 
echo $status . PHP_EOL;
echo $responseBody;

from urllib.request import Request, urlopen
 
payload = "{\n    \"account_name\": \"John Doe\",\n    \"account_number\": \"0245690993\",\n    \"amount\": \"10\",\n    \"bank_code\": \"MTNGH\",\n    \"bank_name\": \"MTNGH\",\n    \"currency\": \"GHS\",\n    \"narration\": \"Test transfer\",\n    \"reference\": \"UNIQUE_TRANSACTION_REFERENCE\",\n    \"paymentMode\": \"momo\"\n  }".encode()
 
request = Request(
    "https://backendapi.sayswitchgroup.com/api/v1/bank_transfer",
    data=payload,
    method="POST",
    headers={
        "Authorization": "Bearer YOUR_SECRET_KEY",
        "Content-Type": "application/json",
    },
)
 
with urlopen(request) as response:
    response_body = response.read().decode()
    print(response.status, response_body)

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
var body = """
    {
        "account_name": "John Doe",
        "account_number": "0245690993",
        "amount": "10",
        "bank_code": "MTNGH",
        "bank_name": "MTNGH",
        "currency": "GHS",
        "narration": "Test transfer",
        "reference": "UNIQUE_TRANSACTION_REFERENCE",
        "paymentMode": "momo"
      }
    """;
 
var request = HttpRequest.newBuilder()
    .uri(URI.create("https://backendapi.sayswitchgroup.com/api/v1/bank_transfer"))
    .header("Authorization", "Bearer YOUR_SECRET_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(body))
    .build();
 
var response = HttpClient.newHttpClient().send(
    request,
    HttpResponse.BodyHandlers.ofString()
);
 
System.out.println(response.statusCode());
System.out.println(response.body());

Use paymentMode value bank for bank payments and momo for mobile money payments.

KES Payments Overview