Retrieve Merchants
GET {{base_url}}/banking/v2/merchants
The ‘Get Merchants’ endpoint returns the list of merchants that are currently categorised by tomato pay. Merchant id and the merchant name are returned in the response.
Query Parameters
| Field | Type | Description |
|---|
| pageId | string | Page offset of results |
Attributes
| Field | Type | Description |
|---|
| id | string | Unique identifier for the merchant |
| name | string | Name of the merchant |
| categoryCode | string | Code for the category |
| addressLine | string | Merchant address (if available) |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | Page offset for results |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
RESPONSES
status: OK
{"results":[{"id":"categoryId1234","name":"Vitalityhealth","categoryCode":"","addressLine":""},{"id":"categoryId2345","name":"Google","categoryCode":"","addressLine":""},{"id":"categoryId3456","name":"Uber","categoryCode":"","addressLine":""}],"links":{}}