Skip to main content
GET
List branches
Returns branches visible to your API key, sorted alphabetically by name.

Filtering by Merchant

Use merchant_id to get branches for a specific merchant:
Omit merchant_id to get all branches visible to your key.

Using Branch IDs

Use the branch_id from this endpoint to filter transactions:

Next Steps

List Merchants

Get merchant UUIDs to filter branches

List Transactions

Filter transactions by branch_id

Authorizations

X-API-Key
string
header
required

API key for authentication. Verified by APISIX via Vanguard. APISIX injects identity headers and strips the raw key before forwarding.

Query Parameters

merchant_id
string<uuid>

Filter by logical merchant UUID from the Merchant Registry. Works cross-DB — returns transactions from both databases if the merchant exists in both.

Response

Branch list

data
object[]
required