Skip to main content

Merchant Info

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
note

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

How to Use

Endpoint
GET/v3/partner/merchant/{merchantId}

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

merchantOBJECT

Merchant details

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"

settlementOBJECT

Settlement details

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

businessScopeSTRING

Scope of business activities

Example: ""

sourceOfFundsSTRING

Source of the merchant's funds

Example: ""

customerOriginSTRING

Origin/channel of the merchant's customers

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

isSameBusinessAddressBOOLEAN

Whether settlement address matches business address

Example: false

invoiceAddressOBJECT

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

inspectListARRAY

List of directors/shareholders submitted for KYC inspection

fullNameSTRING

Full name

Example: "John Doe"

emailSTRING

Email address

Example: ""

positionSTRING

Position/role in the company

Example: ""

countryCodeSTRING

Contact country code

Example: ""

phoneNumberSTRING

Contact phone number

Example: ""

genderSTRING

Gender

Example: "MALE"

birthdayDATETIME

Date of birth

Example: "2000-03-22T16:00:00Z"

nationalitySTRING

Nationality

Example: "MALAYSIAN"

idTypeSTRING

ID type

Example: "IC"

idNoSTRING

ID number

Example: "000322041234"

beginAtSTRING

Inspection start date time

Example: ""

endAtSTRING

Inspection end date time

Example: ""

statusSTRING

Settlement status ("REVIEWING", "ACTIVE")

Example: "REVIEWING"

documentOBJECT

Uploaded document URLs

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

certificateOfRegistrationFileUrlSTRING

Certificate of registration file URL

Example: ""

meetingMinutesFileUrlSTRING

Meeting minutes file URL

Example: ""

organizationChartFileUrlSTRING

Organization chart file URL

Example: ""

documentFileOBJECT

Uploaded document file details

CTOSFileURLSTRING

CTOS file URL

Example: null

OwnerICFileURLSTRING

Owner IC file URL

Example: null

DirectorICFileURLSTRING

Director IC file URL

Example: null

ShareHolderICFileURLSTRING

Shareholder IC file URL

Example: null

BusinessRegistrationFileURLSTRING

Business registration file URL

Example: null

BankStatementFileURLSTRING

Bank statement file URL

Example: null

MOAFileURLSTRING

MOA file URL

Example: null

Form24FileURLSTRING

Form 24 file URL

Example: null

Form49FileURLSTRING

Form 49 file URL

Example: null

Section14FileURLSTRING

Section 14 file URL

Example: null

Form44FileURLSTRING

Form 44 file URL

Example: null

BusinessSitePhotoFileURLSTRING

Business site photo file URL

Example: null

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

averageTicketSizeINTEGER

Average transaction ticket size

Example: 0

averageTurnoverPerMonthINTEGER

Average monthly turnover

Example: 0

paymentSubscriptionSTRING

Payment subscription plan

Example: ""

agentRateNUMBER

Agent commission rate

Example: 0

createdAtDATETIME

Creation timestamp

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

updatedAtDATETIME

Last update timestamp

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

taxInfoOBJECT

Tax registration details

tinSTRING

Tax identification number

Example: ""

sstRegNoSTRING

SST registration number

Example: ""

ttxRegNoSTRING

Tourism tax registration number

Example: ""

msicSTRING

Malaysia Standard Industrial Classification code

Example: ""

hasTaxInfoBOOLEAN

Whether tax info has been submitted

Example: false

notificationEmailsARRAY

Email addresses that receive settlement notifications

Example: []

codeSTRING

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

Example: "SUCCESS"