Merchants Info

GET/v3/partner/merchants

What is this?

Retrieve a list of all merchants under your Partner account. This endpoint returns merchant details including registration status, company information, and subscription settings.

When to Use

Use this endpoint when you:

• Need to view all merchants in your partner account
• Want to check merchant status or details
• Need to display merchant list in your dashboard

This endpoint is for merchants with a Partner account. To activate a Partner account, contact us.

How to Use

Step 1: Authenticate Your Request

Include your Authorization header with the Bearer token obtained from the Client Credentials flow.

Step 2: Make the GET Request

Send a GET request to the endpoint. No request body is required.

Step 3: Review the Response

The response contains an items array with all your merchants. Check the status field to see each merchant's current state.

---

Request Parameters

This is a GET request with no parameters.

---

Response Parameters

itemsObject[]

Array of merchant objects

Example: (See merchant object below)

codeString

"SUCCESS" if the request succeeded. Otherwise returns an error code.

Example: "SUCCESS"

metaObject

Pagination metadata (empty if no pagination)

Example: {}

---

Merchant object (items):

idString

Unique merchant ID

Example: "6170506694335521334"

companyNameString

Registered company name

Example: "REVENUE MONSTER"

brandNameString

Brand name if different from company

Example: ""

companyTypeString

Type of company incorporation

Example: "SOLE PROPRIETOR"

companyLogoUrlString

Public URL for company logo

Example: "https://storage.googleapis.com/rm-sandbox-asset/img/merchant.png"

registrationNumberString

Company registration number

Example: ""

businessCategoryString

Business category

Example: ""

countryCodeString

Country code for contact

Example: "60"

phoneNumberString

Contact phone number

Example: "377334080"

addressLine1String

Street address line 1

Example: ""

cityString

City

Example: ""

stateString

State/Province

Example: ""

postcodeString

Postal/ZIP code

Example: ""

countryString

Country

Example: ""

isActiveBoolean

Whether the merchant account is active

Example: true

statusString

Current status ("REVIEWING", "UNVERIFIED", "ACTIVE")

Example: "REVIEWING"

isPartnerBoolean

Whether this is a partner merchant

Example: true

partnerIdString

Partner ID if applicable

Example: ""

gstNoString

GST registration number

Example: ""

subscriptionObject

Subscription flags. See subscription object below.

Example: (See below)

registrationSourceString

How the merchant was registered

Example: "OPEN_API"

createdAtDateTime

Account creation timestamp

Example: "2021-08-18T03:47:28Z"

updatedAtDateTime

Last update timestamp

Example: "2021-08-18T03:47:28Z"

---

Subscription object (items.subscription):

terminalOfflineEWalletBoolean

Offline e-wallet terminal enabled

Example: false

terminalOfflineCreditCardBoolean

Offline credit card terminal enabled

Example: false

onlineCreditCardBoolean

Online credit card enabled

Example: false