Skip to main content

Merchant Info

GET/v3/partner/merchants/{merchantID}

What is this?

Retrieve detailed information about a specific merchant under your Partner account, including merchant details, settlement information, and document status.

When to Use

Use this endpoint when you:

  • Need to view a specific merchant's complete details
  • Want to check the merchant's settlement or document status
  • Need to verify merchant information for support tickets

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

How to Use

Step 1: Get the Merchant ID

Locate the merchantID for the merchant you want to retrieve. You can get this from the Get Merchants endpoint.

Step 2: Make the GET Request

Include the merchantID as a path parameter in the URL.

Step 3: Review the Response

The response contains merchant and settlement objects with complete details.

Request Parameters

merchantIDStringrequired

The unique ID of the merchant to retrieve

Example: "1629258448138509563"

Response Parameters

itemObject

Contains merchant and settlement objects

Example: (See below)

codeString

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

Example: "SUCCESS"

Merchant object (item.merchant):

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)

createdAtDateTime

Account creation timestamp

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

updatedAtDateTime

Last update timestamp

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

Subscription object (item.merchant.subscription):

terminalOfflineEWalletBoolean

Offline e-wallet terminal enabled

Example: false

terminalOfflineCreditCardBoolean

Offline credit card terminal enabled

Example: false

onlineCreditCardBoolean

Online credit card enabled

Example: false

Settlement object (item.settlement):

idString

Unique settlement ID

Example: "1629258558902992793"

merchantIdString

Associated merchant ID

Example: "1629258448138509563"

isDefaultBoolean

Whether this is the default settlement account

Example: true

companyNameString

Company name

Example: "REVENUE MONSTER"

companyTypeString

Type of company incorporation

Example: "SOLE PROPRIETOR"

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

isSameBusinessAddressBoolean

Whether settlement address matches business address

Example: false

statusString

Settlement status ("REVIEWING", "ACTIVE")

Example: "REVIEWING"

documentObject

Uploaded document URLs. See document object below.

Example: (See below)

documentFileObject

Uploaded document file details. See documentFile object below.

Example: (See below)

bankAccountNoString

Bank account number (masked)

Example: ""

bankAccountTypeString

Bank account type

Example: ""

bankAccountHolderNameString

Bank account holder name

Example: ""

bankNameString

Bank name

Example: ""

bankCodeString

Bank code

Example: ""

averageTicketSizeNumber

Average transaction ticket size

Example: 0

averageTurnoverPerMonthNumber

Average monthly turnover

Example: 0

createdAtDateTime

Creation timestamp

Example: "2021-08-18T04:03:15Z"

updatedAtDateTime

Last update timestamp

Example: "2021-08-18T04:03:15Z"

Document object (item.settlement.document):

ctosFileUrlString

CTOS file URL

Example: ""

ownerICFileUrlString

Owner IC file URL

Example: ""

directorICFileUrlString

Director IC file URL

Example: ""

shareHolderICFileUrlString

Shareholder IC file URL

Example: ""

businessRegistrationFileUrlString

Business registration file URL

Example: ""

bankStatementFileUrlString

Bank statement file URL

Example: ""

moaFileUrlString

MOA file URL

Example: ""

form24FileUrlString

Form 24 file URL

Example: ""

form49FileUrlString

Form 49 file URL

Example: ""

section14FileUrlString

Section 14 file URL

Example: ""

form44FileUrlString

Form 44 file URL

Example: ""

businessSitePhotoFileUrlString

Business site photo file URL

Example: ""

essmDocumentFileUrlString

ESSM document file URL

Example: ""

letterOfConsentFileUrlString

Letter of consent file URL

Example: ""

DocumentFile object (item.settlement.documentFile):

CTOSFileURLString (nullable)

CTOS file URL

Example: null

OwnerICFileURLString (nullable)

Owner IC file URL

Example: null

DirectorICFileURLString (nullable)

Director IC file URL

Example: null

ShareHolderICFileURLString (nullable)

Shareholder IC file URL

Example: null

BusinessRegistrationFileURLString (nullable)

Business registration file URL

Example: null

BankStatementFileURLString (nullable)

Bank statement file URL

Example: null

MOAFileURLString (nullable)

MOA file URL

Example: null

Form24FileURLString (nullable)

Form 24 file URL

Example: null

Form49FileURLString (nullable)

Form 49 file URL

Example: null

Section14FileURLString (nullable)

Section 14 file URL

Example: null

Form44FileURLString (nullable)

Form 44 file URL

Example: null

BusinessSitePhotoFileURLString (nullable)

Business site photo file URL

Example: null

Last updated on by Aiman Danish