Skip to main content
GET
List Merchant Brands

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPAY.

Query Parameters

display_name
string

Case-insensitive prefix match on the merchant's display name. Required unless merchant_code is supplied.

Example:

"Grab"

merchant_code
string

Exact match on the merchant code. Required unless display_name is supplied.

Example:

"10000418"

page_number
integer
default:1
required

The page number to retrieve the next set of items. The number has to be greater than 1, and will default to 1

Required range: x >= 1
page_size
integer
default:10
required

The maximum number of items to return per page. This number can be between 1 - 100, and will default to 10

Required range: 1 <= x <= 100

Response

200 - application/json

OK - Successfully retrieved a list of merchant brands.

total_items
integer

The total counts of available items.

Example:

10

total_pages
integer

The total pages of available items.

Example:

1

data
object[]