Skip to main content

Onboarding API: looking up brands

How to find the brand name key to send in onboarding requests.

Every merchant belongs to a brand, and onboarding requests identify it by the brand’s name key, for example progitek, not by its ID.

Request

GET /v1/brands on the API host, with a JWT or an API key (see Onboarding API: authentication and environments).

Query parameter

Required

Description

limit

Yes

Records per page, 1 to 1000

page

Yes

Page number, starting at 0

curl "https://api.valpay.dev/v1/brands?limit=100&page=0" \
-H "X-API-KEY: YOUR_API_KEY"

Response

The brands are in data. Use each brand’s name as the brand value in onboarding requests.

{
"data": [
{ "_id": "670ea2b7857fcfe2f9488e07", "name": "progitek" }
]
}

The list only contains brands your credentials can access. A brand can also restrict which industry codes its merchants may use.

Did this answer your question?