> ## Documentation Index
> Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Merchant Brands
> Business Visa only
Searches the UQPAY merchant brand catalog. Use it to resolve the `merchant_code` values that `risk_controls.allowed_merchants` and `risk_controls.blocked_merchants` accept.
Supply at least one of `display_name` or `merchant_code` — a request with neither is rejected, so the full catalog cannot be listed. When both are supplied, only entries matching both are returned.
See [Spending controls](/card-issuance/v1.6/guide/spending-controls) for how to apply the returned codes to a card.
## OpenAPI
````yaml /card-issuance/v1.6/issuing.yaml get /v1/issuing/merchant_brands
openapi: 3.0.2
info:
title: Issuing API
version: 0.0.1
description: >
UQPAY Issuing API allows you to issue virtual cards, manage cardholders, and
monitor card transactions.
## What you can do
- Create and manage virtual cards (issue, activate, freeze, cancel)
- Onboard and verify cardholders with KYC
- Set spending limits and card controls
- Recharge and withdraw card balances
- Query card transactions and account balances
- Transfer funds between issuing accounts
- Generate and download reports
## Authentication
All requests require a valid auth token obtained via the [Access
Token](/account-center/v1.6/api-reference/access-token) endpoint. Include
the token in the `x-auth-token` header.
## Idempotency
POST requests support the `x-idempotency-key` header to safely retry without
creating duplicate resources.
contact:
name: UQPAY Support Team
url: https://www.uqpay.com/support
email: support@uqpay.com
license:
name: Proprietary
url: https://www.uqpay.com/legal/api-terms
termsOfService: https://www.uqpay.com/legal/terms
x-api-id: uqpay-issuing-api-v1.6.0
x-categories:
- Card Issuing
- Transaction Processing
x-features:
- Virtual Card Issuance
- Real-time Processing
- Webhook Notifications
- Comprehensive Reporting
- Transaction Monitoring
servers:
- url: https://api-sandbox.uqpaytech.com/api
description: Sandbox base URL.
- url: https://api.uqpay.com/api
description: Production base URL.
security: []
tags:
- name: Card Lifecycle
description: >-
Create cards and manage their full lifecycle — issue, retrieve, update,
activate, assign, and change status.
- name: Card Secure Data
description: >-
Access sensitive card data (PAN, CVV) through the PCI-compliant endpoint
or a tokenized iframe. Availability depends on your PCI status, not the
card product.
- name: Card Funding
description: Load and unload a card's stored balance for prepaid-style cards.
- name: Card PIN
description: >-
Set and manage card PINs. `reset-pin` covers physical cards;
`manage-card-pin` covers virtual cards.
- name: Card Add-ons
description: >-
Product-specific card capabilities. Each operation applies only to certain
card products — see [Card
products](/card-issuance/v1.6/guide/card-products).
- name: Card Arts
description: >-
Manage the visual designs (card arts) available to your issuing account.
Set an account-wide default, or pass `card_art_id` when issuing or
updating a card to override per card. Available on Personal Visa.
- name: Cardholders
description: >-
You can create cardholders, which are authorized representatives of your
business that can be issued cards.
- name: Transactions
description: >-
These APIs allow you to retrieve information on transactions that are made
on your user's cards.
- name: Products
description: >-
With this set of APIs, you will be able to create card orders for your
customers.
- name: Balances
description: >-
The available and pending amounts for each currency are broken down
further by payment source types. You can retrieve it to see the balance
currently on your issuing account.
- name: Transfers
description: Transfer funds between issuing accounts.
- name: Reports
description: Generate and download issuing reports.
- name: Simulator
description: Simulate card transactions on the sandbox environment.
paths:
/v1/issuing/merchant_brands:
get:
tags:
- Card Lifecycle
summary: List Merchant Brands
description: >
Business Visa only
Searches the UQPAY merchant brand catalog. Use it to resolve the
`merchant_code` values that `risk_controls.allowed_merchants` and
`risk_controls.blocked_merchants` accept.
Supply at least one of `display_name` or `merchant_code` — a request
with neither is rejected, so the full catalog cannot be listed. When
both are supplied, only entries matching both are returned.
See [Spending controls](/card-issuance/v1.6/guide/spending-controls) for
how to apply the returned codes to a card.
operationId: list-merchant-brands
parameters:
- $ref: '#/components/parameters/MerchantDisplayName'
- $ref: '#/components/parameters/MerchantCode'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/MerchantPageSize'
responses:
'200':
description: OK - Successfully retrieved a list of merchant brands.
headers:
x-response-id:
$ref: '#/components/headers/XResponseId'
content:
application/json:
schema:
title: ListMerchantBrandsResponse
type: object
properties:
total_items:
$ref: '#/components/schemas/TotalItems'
total_pages:
$ref: '#/components/schemas/TotalPages'
data:
type: array
items:
$ref: '#/components/schemas/MerchantBrand'
security:
- XAuthToken: []
components:
parameters:
MerchantDisplayName:
name: display_name
description: >-
Case-insensitive prefix match on the merchant's display name. Required
unless `merchant_code` is supplied.
in: query
required: false
schema:
type: string
example: Grab
MerchantCode:
name: merchant_code
description: >-
Exact match on the merchant code. Required unless `display_name` is
supplied.
in: query
required: false
schema:
type: string
example: '10000418'
PageNumber:
name: page_number
description: >-
The page number to retrieve the next set of items. The number has to be
greater than 1, and will default to 1
in: query
required: true
schema:
type: integer
minimum: 1
default: 1
MerchantPageSize:
name: page_size
description: >-
The maximum number of items to return per page. This number can be
between 1 - 100, and will default to 10
in: query
required: true
schema:
type: integer
minimum: 1
maximum: 100
default: 10
headers:
XResponseId:
description: >-
Universally unique identifier (UUID v4) for the response. Helpful for
identifying a request when communicating with UQPAY support.
schema:
type: string
format: uuid
example: 2adba88e-9d63-44bc-b975-9b6ae3440dde
schemas:
TotalItems:
type: integer
example: 10
description: The total counts of available items.
TotalPages:
type: integer
example: 1
description: The total pages of available items.
MerchantBrand:
type: object
description: A merchant brand entry from the UQPAY merchant catalog.
properties:
merchant_code:
type: string
description: >-
Stable identifier of the merchant brand. This is the value to pass
in `allowed_merchants` or `blocked_merchants`.
example: '10000418'
display_name:
type: string
description: Merchant brand name shown to cardholders and operators.
example: TikTok
securitySchemes:
XAuthToken:
type: apiKey
in: header
name: x-auth-token
description: The API token for login provided by UQPAY.
````