Branches represent physical store locations for a merchant. Each branch can have its own POS terminals and payment settings.
Create Branch
Requires a valid Bearer token in the Authorization header.
Request Body
Branch display name (e.g., Colombo Main Store).
Physical address of the branch.
City where the branch is located.
Branch contact phone number.
Example Request
Example Response (201)
List Branches
Returns all branches for the authenticated merchant.
Query Parameters
Items per page (max 100).
Example Response (200)
Get Branch
Path Parameters
The branch identifier (e.g., branch_abc123).
Example Response (200)
Delete Branch
Permanently deletes a branch. Active POS terminals associated with the branch will be deactivated.
Path Parameters
The branch identifier (e.g., branch_abc123).
Example Response (200)
Error Responses