Get supported institutions
curl --request GET \
--url https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions \
--header 'x-api-secret: <x-api-secret>'import requests
url = "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions"
headers = {"x-api-secret": "<x-api-secret>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-secret': '<x-api-secret>'}};
fetch('https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-secret: <x-api-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-secret", "<x-api-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions")
.header("x-api-secret", "<x-api-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-secret"] = '<x-api-secret>'
response = http.request(request)
puts response.read_body{
"status": "success",
"timestamp": "2023-11-07T05:31:56Z",
"message": "Success",
"data": [
{
"id": "69ae7e39f67d9ae4f44f18e5",
"swiftCode": "ABAYETAA",
"institutionName": "Abay Bank",
"logo": "<string>",
"pushPayment": true,
"otpPayment": false,
"ussdPayment": true,
"ussdCallbackType": "Callback"
}
]
}{
"status": "error",
"timestamp": "2025-05-07T07:31:30.824Z",
"path": "/v2/starpay-api/",
"error": {
"code": "BadRequestException",
"message": "Missing required payload data, pk and payload is required"
}
}{
"message": "Something wrong",
"status": "error",
"timestamp": "2025-05-07T07:31:30.824Z",
"path": "/v2/starpay-api/",
"error": {
"code": "GEN_004",
"message": "An unexpected server error occurred."
}
}{
"message": "Something wrong",
"status": "error",
"timestamp": "2025-05-07T07:31:30.824Z",
"path": "/v2/starpay-api/",
"error": {
"code": "ABC_001",
"message": "not found"
}
}{
"message": "Something wrong",
"status": "error",
"timestamp": "2025-05-07T07:31:30.824Z",
"path": "/v2/starpay-api/",
"error": {
"code": "GEN_004",
"message": "An unexpected server error occurred."
}
}Get institutions
GET
/
erp
/
get-institutions
Get supported institutions
curl --request GET \
--url https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions \
--header 'x-api-secret: <x-api-secret>'import requests
url = "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions"
headers = {"x-api-secret": "<x-api-secret>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-secret': '<x-api-secret>'}};
fetch('https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-secret: <x-api-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-secret", "<x-api-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions")
.header("x-api-secret", "<x-api-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.starpayethiopia.com/v1/starpay-api/erp/get-institutions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-secret"] = '<x-api-secret>'
response = http.request(request)
puts response.read_body{
"status": "success",
"timestamp": "2023-11-07T05:31:56Z",
"message": "Success",
"data": [
{
"id": "69ae7e39f67d9ae4f44f18e5",
"swiftCode": "ABAYETAA",
"institutionName": "Abay Bank",
"logo": "<string>",
"pushPayment": true,
"otpPayment": false,
"ussdPayment": true,
"ussdCallbackType": "Callback"
}
]
}{
"status": "error",
"timestamp": "2025-05-07T07:31:30.824Z",
"path": "/v2/starpay-api/",
"error": {
"code": "BadRequestException",
"message": "Missing required payload data, pk and payload is required"
}
}{
"message": "Something wrong",
"status": "error",
"timestamp": "2025-05-07T07:31:30.824Z",
"path": "/v2/starpay-api/",
"error": {
"code": "GEN_004",
"message": "An unexpected server error occurred."
}
}{
"message": "Something wrong",
"status": "error",
"timestamp": "2025-05-07T07:31:30.824Z",
"path": "/v2/starpay-api/",
"error": {
"code": "ABC_001",
"message": "not found"
}
}{
"message": "Something wrong",
"status": "error",
"timestamp": "2025-05-07T07:31:30.824Z",
"path": "/v2/starpay-api/",
"error": {
"code": "GEN_004",
"message": "An unexpected server error occurred."
}
}The institution capability flags in the response mean:
pushPayment: institution supports in-app push payment.otpPayment: institution supports OTP-based payment.ussdPayment: institution supports USSD push payment.
Headers
API secret key.
Example:
"MFUxSN98EV5IUU+RhYZh2f866adcTa4F5HJ2dGI3t8+MH3cvfk/gAZ492TnxwdiI"
⌘I