API Reference

List Locations

get
{base_url}/api/distributor/v1/locations

Returns paginated locations the authenticated Developer Partner has access to. Supports search, mcc/merchant_category, and the usual cross-cut entity + date-range filters.

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

Substring match on location name

string

Narrow to locations whose terminals match this MCC

string

Narrow to a friendly merchant category key

uuid

Narrow to a single distributor (Marketer) UUID

uuid

Narrow to a single business UUID

uuid

Narrow to a single distributor card UUID

uuid

Narrow to a single cardholder UUID

date-time

Start timestamp (ISO 8601)

date-time

End timestamp (ISO 8601)

string

Whitelisted sort key: name or created_at

integer
≥ 1
Defaults to 1

1-based page number

integer
1 to 100
Defaults to 20

Results per page (max 100)

Responses

400

bad request for unknown merchant category

401

unauthorized request

403

forbidden request

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?