Create a Sub-account

Create a new sub-account

Method and URL

POST | [BASE_URL]/v1/sub-merchants

Request

Example Body Request Payload

{
  "name": "Reforza Corporation",
  "shortName": "RCI",
  "description": "Whale Technology Company",
  "logo": "https://acme.inc/assets/logo.png",
  "merchantEmail": "[e-mail]",
  "merchantPhone": "081217003600",
  "businessCountry": "ID",
  "businessType": "COMPANY",
  "businessStructure": "PERSEROAN TERBATAS",
  "parentIndustry": "Airlines",
  "childIndustry": "Airlines, Air Carriers",
  "mcc": "4511",
  "countryOfEntity": "ID",
  "digitalStatus": "Digital",
  "picName": "Reforza",
  "picEmail": "[e-mail]",
  "picPhone": "081217003600",
  "picJobTitle": "owner",
  "address": "H Rasuna Said, Jakarta",
  "postCode": "60541",
  "autoWithdrawal": "ON",
  "bankAccount": {
    "accountName": "Reforza Jordan Geotama",
    "accountNumber": "90016666001",
    "bankName": "SMBC",
    "channelCode": "JENIUS"
  }
}

Request Body Schema

Schema Path	Description	Specifications
name	Name of the sub-merchant	Required
shortName	Short Name of the sub-merchant, used as the transaction descriptor	Required
description	Description of the sub-merchant	Optional
logo	URL of the sub-merchant logo to be uploaded. Expecting a public accessed URL	Required
merchantEmail	Email Address of the sub-merchant	Required Unique
merchantPhone	Phone Number of the sub-merchant	Required
businessCountry	Two letter digits country code based on ISO 3166-1 alpha-2 where the business resides	Required
businessType	Type of the business of sub-merchant, one of INDVIDUAL or COMPANY.	Required
businessStructure	Business structure of the sub-merchants. e.g. CV, PT, etc. Business structure is regulated differently in each Country.	Required
parentIndustry	Industry in general Merchant Industry List	Optional
childIndustry	Industry in specific Merchant Industry List	Optional
mcc	Merchant Category Code MCC Code List	Optional
countryOfEntity	Merchant's operational Country ISO 3166-1 alpha-2	Optional
digitalStatus	Selling Digital Product / Non Digital Product, possible values are Digital or Non-digital	Optional
picName	PIC Full Name	Required
picPhone	PIC phone number	Required
picEmail	PIC email address	Required
picJobTitle	PIC Job Title	Optional
address	Full Address of Sub-merchant's Company	Required
postCode	Postal code of the sub-merchant company address	Required
autoWithdrawal	Options to enable/disable auto-withdrawal capability, default will be "ON"	Optional
bankAccount		Required
accountName	Account Name of Withdrawal destination	Optional
accountNumber	Account Number of Withdrawal destination	Required
bankName	Bank name for Withdrawal destination such as Bank, E wallet or other channels List of Channel code can be accessed Channel Codes	Optional
channelCode	Channel code for Withdrawal destination such as Bank, E wallet or other channels List of Channel code can be accessed Channel Codes	Required

Response

Example Response Body

{
  "code": "00",
  "message": "Success",
  "data": {
    "uuid": "d8361719-290b-4b80-8e75-8329321a4000",
    "name": "Reforza Corporation",
    "shortName": "RCI",
    "description": "Whale Technology Company",
    "address": "H Rasuna Said, Jakarta",
    "postCode": "60541",
    "logo": "https://acme.inc/assets/logo.png",
    "merchantEmail": "[e-mail]",
    "merchantPhone": "081217003600",
    "picEmail": "[e-mail]",
    "picPhone": "081217003600",
    "picName": "Reforza",
    "picJobTitle": "owner",
    "businessType": "COMPANY",
    "businessStructure": "PERSEROAN TERBATAS",
    "businessCountry": "ID",
    "parentIndustry": "Airlines",
    "childIndustry": "Airlines, Air Carriers",
    "mcc": "4511",
    "countryOfEntity": "ID",
    "digitalStatus": "Digital",
    "parentId": "e485e01b-ff59-4a47-bb7d-9b39064f3388",
    "autoWithdrawal": "ON",
    "bankAccount": {
      "channelCode": "JENIUS",
      "bankName": "PT BANK BTPN TBK",
      "accountNumber": "90016666001",
      "accountName": "Sdr. Dummy Account Success"
    }
  }
}

Response Data Schema

Schema Path	Description	Data Type Validation
code	Response Code from Pivot	String
message	Human readable message that represent response from Pivot	String
data	Response Data from Pivot contains sub-accounts Object	Object