Skip to main content

Update Merchant

PATCH/v3/partner/merchant/{merchantID}

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

What is this?

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

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"

averageTicketSizeUint

Example: 1000000

averageTurnoverPerMonthUint

Example: 1000000

businessScopeString

Example: "some business scope"

invoiceAddressObject (nullable)

See invoiceAddress object below.

Example: (Refer below)

documentObject

See document object below.

Example: (Refer below)

inspectListArray (nullable)

See inspectList object below.

Example: (Refer below)

bankAccountTypeString

Example: "CORPORATE"

bankAccountHolderNameString

Example: "Revenue Monster"

bankAccountNoString

Example: "32312323"

bankCodeString

Example: "HLBB"

latitudeFloat

Example: 0.0

longitudeFloat

Example: 0.0

paymentSubscriptionString

Example: "BOTH"

terminalOfflineEWalletBool

Example: false

terminalOfflineCreditCardBool

Example: false

onlineCreditCardBool

Example: false

invoiceAddress object:

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"

inspectList object:

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"

beginDateTimeString

Example: ""

endDateTimeString

Example: ""

document object:

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"

Response Parameters

itemObject

The updated settlement record.

Example: (Refer to explanation below)

codeString

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

Example: "SUCCESS"

Settlement object (item):

idString

Settlement ID

Example: "1629258558902992793"

merchantIdString

Merchant ID

Example: "1629258448138509563"

isDefaultBool

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 (nullable)

See invoiceAddress object below.

Example: (Refer below)

inspectListArray (nullable)

See inspectList object below.

Example: (Refer below)

statusString

Current status of settlement

Example: "UNVERIFIED"

documentObject

See document object below.

Example: (Refer below)

documentFileObject

See documentFile object below.

Example: (Refer below)

bankAccountNoString

Example: "32312323"

bankAccountTypeString

Example: "CORPORATE"

bankAccountHolderNameString

Example: "Revenue Monster"

bankNameString

Example: "HONG LEONG BANK"

bankCodeString

Example: "HLBB"

averageTicketSizeUint

Example: 0

averageTurnoverPerMonthUint

Example: 0

paymentSubscriptionString

Example: ""

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"

invoiceAddress object:

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"

inspectList object:

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

document object:

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"

documentFile object:

CTOSFileURLString (nullable)

Example: null

OwnerICFileURLString (nullable)

Example: null

DirectorICFileURLString (nullable)

Example: null

ShareHolderICFileURLString (nullable)

Example: null

BusinessRegistrationFileURLString (nullable)

Example: null

BankStatementFileURLString (nullable)

Example: null

MOAFileURLString (nullable)

Example: null

Form24FileURLString (nullable)

Example: null

Form49FileURLString (nullable)

Example: null

Section14FileURLString (nullable)

Example: null

Form44FileURLString (nullable)

Example: null

BusinessSitePhotoFileURLString (nullable)

Example: null

Last updated on by Aiman Danish