Skip to main content
GET
/
erp
/
get-institutions
Get supported institutions
curl --request GET \
  --url https://starpayqa.starpayethiopia.com/v1/starpay-api/erp/get-institutions \
  --header 'x-api-secret: <x-api-secret>'
{
  "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"
    }
  ]
}
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

​
x-api-secret
string
required

API secret key.

Example:

"MFUxSN98EV5IUU+RhYZh2f866adcTa4F5HJ2dGI3t8+MH3cvfk/gAZ492TnxwdiI"

Response

Institution list fetched successfully.

​
status
string
required
Example:

"success"

​
timestamp
string<date-time>
required
​
message
string
required
Example:

"Success"

​
data
object[]
required

List of institutions with their supported payment options.