Skip to main content
GET
/
branches
/
api
/
v1
/
merchant-branches
Fetch All Branches
curl --request GET \
  --url https://api.payaza.africa/live/branches/api/v1/merchant-branches \
  --header 'Authorization: <api-key>'
{
  "message": "Merchant branches fetched successfully",
  "success": true,
  "status": 200,
  "data": [
    {
      "name": "Mr. Aaron & Sons Co",
      "status": "Active",
      "branch_id": 8589,
      "account_name": "Mr. Aaron & Sons Co",
      "created_at": "2025-10-24T11:23:18.144631"
    },
    {
      "name": "A new center",
      "status": "Active",
      "branch_id": 5553,
      "account_name": "Dev Guide 1",
      "created_at": "2025-02-17T12:41:58.381125"
    },
    {
      "name": "Rest Branch 400",
      "status": "Active",
      "branch_id": 3738,
      "account_name": "Rest Branch 10",
      "created_at": "2024-07-10T14:31:23.817782"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 100,
    "total": 3
  },
  "resp_code": "BRN_S200"
}

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Response

Fetch All Branches Response

message
string

Status message.

Example:

"Merchant branches fetched successfully"

success
boolean

Indicates if the request was successful.

Example:

true

status
integer

HTTP status code.

Example:

200

data
object[]

List of merchant branches.

meta
object

Pagination metadata.

resp_code
string

Internal response code.

Example:

""