Skip to main content

Update Merchant

note

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

Update an existing merchant's information under your Partner account. Use this to modify company details, address, bank account information, and business details.

When to Use​

▾

Use this endpoint when:

  • A merchant needs to update their company information
  • Business details such as address or contact information change
  • Bank account or settlement information needs to be updated

How to Use​

▾
Endpoint
PATCH/v3/partner/merchant/{merchantId}

Step 1: Get the Merchant ID​

▾

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

Step 2: Prepare the Updated Data​

▾

Gather the fields you want to update. Only include the fields that need to be changed — all fields are optional.

Step 3: Make the PATCH Request​

▾

Send the updated merchant information with the merchantID as a path parameter.

Step 4: Review the Response​

▾

Check the code field. If "SUCCESS", the merchant was updated. The full merchant object is returned.


Request Parameters​

▾

Pass the merchant ID as a path parameter in the URL.

brandNameSTRING

Example: "Revenue Monster"

websiteUrlSTRING

Example: "https://revenuemonster.my"

registrationNumberSTRING

Example: "XAS1233123"

establishedAtDATETIME

Example: "2006-01-02T15:04:05Z"

addressLine1STRING

Example: "1, Jalan Pertanian 25"

addressLine2STRING

Example: "Taman Universiti"

postCodeSTRING

Example: "81300"

citySTRING

Example: "SKUDAI"

stateSTRING

Example: "JOHOR"

countrySTRING

Example: "MALAYSIA"

countryCodeSTRING

Example: "60"

phoneNumberSTRING

Example: "187824152"

companyNameSTRING

Example: "Revenue Monster"

companyTypeSTRING

Example: "PRIVATE LIMITED COMPANY (SDN BHD)"

businessCategorySTRING

Example: "COMPUTER AND ELECTRONICS"

averageTicketSizeINTEGER

Example: 1000000

averageTurnoverPerMonthINTEGER

Example: 1000000

businessScopeSTRING

Example: "some business scope"

invoiceAddressOBJECT

Invoice address

addressLine1STRING

Address line 1

Example: "1, Jalan Pertanian 25"

addressLine2STRING

Address line 2

Example: "Taman Universiti"

postCodeSTRING

Postcode

Example: "81300"

citySTRING

City

Example: "SKUDAI"

stateSTRING

State

Example: "JOHOR"

countrySTRING

Country

Example: "MALAYSIA"

documentOBJECT

Supporting document URLs

ctosFileUrlSTRING

Example: "https://somefileendpoint.com"

ownerICFileUrlSTRING

Example: "https://somefileendpoint.com"

directorICFileUrlSTRING

Example: "https://somefileendpoint.com"

shareHolderICFileUrlSTRING

Example: "https://somefileendpoint.com"

businessRegistrationFileUrlSTRING

Example: "https://somefileendpoint.com"

bankStatementFileUrlSTRING

Example: "https://somefileendpoint.com"

moaFileUrlSTRING

Example: "https://somefileendpoint.com"

form24FileUrlSTRING

Example: "https://somefileendpoint.com"

form49FileUrlSTRING

Example: "https://somefileendpoint.com"

section14FileUrlSTRING

Example: "https://somefileendpoint.com"

form44FileUrlSTRING

Example: "https://somefileendpoint.com"

businessSitePhotoFileUrlSTRING

Example: "https://somefileendpoint.com"

inspectListARRAY

List of persons to inspect

fullNameSTRING

Example: "NG SZE CHEN"

genderSTRING

Example: "MALE"

birthdayDATETIME

Example: "1999-07-14T15:59:59Z"

nationalitySTRING

Example: "MALAYSIAN"

idTypeSTRING

Example: "IC"

idNoSTRING

Example: "2131290134"

bankAccountTypeSTRING

Example: "CORPORATE"

bankAccountHolderNameSTRING

Example: "Revenue Monster"

bankAccountNoSTRING

Example: "32312323"

bankCodeSTRING

Example: "HLBB"

latitudeFLOAT

Example: 0.0

longitudeFLOAT

Example: 0.0

paymentSubscriptionSTRING

Example: "BOTH"

terminalOfflineEWalletBOOLEAN

Example: false

terminalOfflineCreditCardBOOLEAN

Example: false

onlineCreditCardBOOLEAN

Example: false


Response Parameters​

▾
itemOBJECT

The updated settlement record.

idSTRING

Settlement ID

Example: "1629258558902992793"

merchantIdSTRING

Merchant ID

Example: "1629258448138509563"

isDefaultBOOLEAN

Whether this is the default settlement account

Example: true

companyNameSTRING

Company name of merchant

Example: "REVENUE MONSTER"

companyTypeSTRING

Type of company incorporation

Example: "PRIVATE LIMITED COMPANY (SDN BHD)"

registrationNumberSTRING

Registration number of merchant

Example: "12344"

businessCategorySTRING

Business category of merchant

Example: "SOFTWARE AND IT"

businessScopeSTRING

Business scope of merchant

Example: "some business scope"

sourceOfFundsSTRING

Source of funds of merchant

Example: ""

customerOriginSTRING

Customer origin of merchant

Example: ""

establishedAtDATETIME

Established date time of merchant

Example: "2006-01-02T15:04:05Z"

countryCodeSTRING

Country code of merchant contact number

Example: "60"

phoneNumberSTRING

Phone number of merchant

Example: "187824152"

addressLine1STRING

Address 1 of merchant

Example: "1, Jalan Pertanian 25"

addressLine2STRING

Address 2 of merchant

Example: "Taman Universiti"

postcodeSTRING

Postcode of merchant

Example: "81300"

citySTRING

City of merchant

Example: "SKUDAI"

stateSTRING

State of merchant

Example: "JOHOR"

countrySTRING

Country of merchant

Example: "MALAYSIA"

isSameBusinessAddressBOOLEAN

Example: false

invoiceAddressOBJECT

Invoice address

addressLine1STRING

Address line 1

Example: "1, Jalan Pertanian 25"

addressLine2STRING

Address line 2

Example: "Taman Universiti"

postcodeSTRING

Postcode

Example: "81300"

citySTRING

City

Example: "SKUDAI"

stateSTRING

State

Example: "JOHOR"

countrySTRING

Country

Example: "MALAYSIA"

inspectListARRAY

List of persons to inspect

fullNameSTRING

Example: "NG SZE CHEN"

emailSTRING

Example: ""

positionSTRING

Example: ""

countryCodeSTRING

Example: "60"

phoneNumberSTRING

Example: ""

genderSTRING

Example: "MALE"

birthdayDATETIME

Example: "1999-07-14T15:59:59Z"

nationalitySTRING

Example: "MALAYSIAN"

idTypeSTRING

Example: "IC"

idNoSTRING

Example: "2131290134"

beginAtSTRING

Example: ""

endAtSTRING

Example: ""

statusSTRING

Current status of settlement

Example: "UNVERIFIED"

documentOBJECT

Supporting document URLs

ctosFileUrlSTRING

Example: "https://somefileendpoint.com"

ownerICFileUrlSTRING

Example: "https://somefileendpoint.com"

directorICFileUrlSTRING

Example: "https://somefileendpoint.com"

shareHolderICFileUrlSTRING

Example: "https://somefileendpoint.com"

businessRegistrationFileUrlSTRING

Example: "https://somefileendpoint.com"

bankStatementFileUrlSTRING

Example: "https://somefileendpoint.com"

moaFileUrlSTRING

Example: "https://somefileendpoint.com"

form24FileUrlSTRING

Example: "https://somefileendpoint.com"

form49FileUrlSTRING

Example: "https://somefileendpoint.com"

section14FileUrlSTRING

Example: "https://somefileendpoint.com"

form44FileUrlSTRING

Example: "https://somefileendpoint.com"

businessSitePhotoFileUrlSTRING

Example: "https://somefileendpoint.com"

essmDocumentFileUrlSTRING

Example: ""

letterOfConsentFileUrlSTRING

Example: ""

certificateOfRegistrationFileUrlSTRING

Example: ""

meetingMinutesFileUrlSTRING

Example: ""

organizationChartFileUrlSTRING

Example: ""

documentFileOBJECT

Uploaded document file URLs

CTOSFileURLSTRING

Example: null

OwnerICFileURLSTRING

Example: null

DirectorICFileURLSTRING

Example: null

ShareHolderICFileURLSTRING

Example: null

BusinessRegistrationFileURLSTRING

Example: null

BankStatementFileURLSTRING

Example: null

MOAFileURLSTRING

Example: null

Form24FileURLSTRING

Example: null

Form49FileURLSTRING

Example: null

Section14FileURLSTRING

Example: null

Form44FileURLSTRING

Example: null

BusinessSitePhotoFileURLSTRING

Example: null

bankAccountNoSTRING

Example: "32312323"

bankAccountTypeSTRING

Example: "CORPORATE"

bankAccountHolderNameSTRING

Example: "Revenue Monster"

bankNameSTRING

Example: "HONG LEONG BANK"

bankCodeSTRING

Example: "HLBB"

averageTicketSizeINTEGER

Example: 0

averageTurnoverPerMonthINTEGER

Example: 0

paymentSubscriptionSTRING

Example: ""

agentRateNUMBER

Agent commission rate

Example: 0

createdAtDATETIME

Creation date time of settlement

Example: "2021-06-02T14:37:25+08:00"

updatedAtDATETIME

Last update date time of settlement

Example: "2021-06-02T14:37:25+08:00"

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

codeSTRING

"SUCCESS" if the call succeeded. Otherwise returns an error code object. See Appendix 1: Error Codes.

Example: "SUCCESS"