v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Branches

Fetch All Branches

This fetches all branches that have been created by a Payaza account.

get/branches/api/v1/merchant-branches

Response

Fetch All Branches Response

messagestring

Status message.

successboolean

Indicates if the request was successful.

statusinteger

HTTP status code.

resp_codestring

Internal response code.

Example response

{
  "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"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 100,
    "total": 3
  }
}