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 enabled for Transaction Reporting. Send the complete value exactly as issued.

Query Parameters

merchant_id
string<uuid>

Filter by merchant. Canonical lowercase UUID; uppercase or non-canonical forms are rejected.

page_size
integer
default:20

Number of results per page. Integer 1 to 100 (default 20). Values above 100 are clamped to 100.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor token from a previous response's next_cursor field.

Response

Branch list

data
object[]
required
pagination
object