HomeGuidesAPI Reference
API Reference

Branch Details

Get Branch Details by BranchId, ACCESS LEVEL: SUPER_ADMIN, PARTNER, MERCHANT

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Retrieve details of a specific branch.


Endpoint

GET https://demo-api.edfapay.com/api/v1/branches/{id}


Path Parameters

FieldTypeRequiredDescription
idUUIDYesBranch ID

Response Body

FieldTypeDescription
codeIntegerResponse code
messageStringStatus
data.idUUIDBranch ID
data.nameStringBranch name
data.nameARStringArabic name
data.businessUnitIdUUIDBusiness unit
data.addressStringAddress
data.countryCodeStringCountry code
data.cityIdIntegerCity ID
data.activeBooleanActive status

Response Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "name": "Test Branch",
    "nameAR": "فرع",
    "businessUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "address": "Test Address",
    "countryCode": "818",
    "cityId": 8,
    "active": true
  }
}
Path Params
uuid
required
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
*/*