Merchants Info

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

note

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

How to Use

▾

Endpoint

GET/v3/partner/merchants

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

▾

itemsARRAY

Array of merchant objects

idSTRING

Unique merchant ID

Example: "6170506694335521334"

companyNameSTRING

Registered company name

Example: "REVENUE MONSTER"

brandNameSTRING

Brand name if different from company

Example: ""

shortNameSTRING

Short name / alias for the merchant

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: ""

businessScopeSTRING

Scope of business activities

Example: ""

sourceOfFundsSTRING

Source of the merchant's funds

Example: ""

customerOriginSTRING

Origin/channel of the merchant's customers

Example: ""

websiteUrlSTRING

Merchant's website URL

Example: ""

establishedAtDATETIME

Established date time of the company

Example: "0001-01-01T00:00:00Z"

countryCodeSTRING

Country code for contact

Example: "60"

phoneNumberSTRING

Contact phone number

Example: "377334080"

addressLine1STRING

Street address line 1

Example: ""

addressLine2STRING

Street address line 2

Example: ""

postcodeSTRING

Postal/ZIP code

Example: ""

citySTRING

City

Example: ""

stateSTRING

State/Province

Example: ""

countrySTRING

Country

Example: ""

invoiceAddressOBJECT

Merchant's invoice/billing address

addressLine1STRING

Invoice address line 1

Example: ""

addressLine2STRING

Invoice address line 2

Example: ""

postcodeSTRING

Invoice address postcode

Example: ""

citySTRING

Invoice address city

Example: ""

stateSTRING

Invoice address state

Example: ""

countrySTRING

Invoice address country

Example: ""

isActiveBOOLEAN

Whether the merchant account is active

Example: true

statusSTRING

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

Example: "REVIEWING"

isMasterMerchantBOOLEAN

Whether this merchant is a master merchant

Example: false

masterMerchantIdSTRING

Master merchant ID, if any

Example: ""

isPartnerBOOLEAN

Whether this is a partner merchant

Example: true

partnerIdSTRING

Partner ID if applicable

Example: ""

gstNoSTRING

GST registration number

Example: ""

paymentSubscriptionSTRING

Payment subscription plan

Example: ""

subscriptionOBJECT

Subscription flags

terminalOfflineEWalletBOOLEAN

Offline e-wallet terminal enabled

Example: false

terminalOfflineCreditCardBOOLEAN

Offline credit card terminal enabled

Example: false

onlineCreditCardBOOLEAN

Online credit card enabled

Example: false

onlineCreditCardWhitelistCountriesARRAY

Countries whitelisted for online credit card payment

Example: []

partialRefundBOOLEAN

Partial refund enabled

Example: false

smsOpenApiBOOLEAN

SMS Open API enabled

Example: false

recurringPaymentsBOOLEAN

Recurring payments enabled

Example: false

tokenizedPaymentsBOOLEAN

Tokenized payments enabled

Example: false

merchantWalletBOOLEAN

Merchant wallet enabled

Example: false

vopApiBOOLEAN

VOP API enabled

Example: false

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"

codeSTRING

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

Example: "SUCCESS"

metaOBJECT

Pagination metadata (empty if no pagination)

Example: {}