Create a Sub-account
Create a new sub-account
Method and URL
POST [BASE_URL]/v1/sub-merchants
Request
Request Body
{
"name": "Reforza Corporation",
"shortName": "RCI",
"description": "Whale Technology Company",
"logo": "https://acme.inc/assets/logo.png",
"merchantEmail": "admin@corp.inc",
"merchantPhone": "081217003600",
"businessCountry": "ID",
"businessType": "COMPANY",
"businessStructure": "PERSEROAN TERBATAS",
"parentIndustry": "Airlines",
"childIndustry": "Airlines, Air Carriers",
"mcc": "4511",
"countryOfEntity": "ID",
"digitalStatus": "Digital",
"picName": "Reforza",
"picEmail": "admin@corp.inc",
"picPhone": "081217003600",
"picJobTitle": "owner",
"address": "H Rasuna Said, Jakarta",
"postCode": "60541",
"autoWithdrawal": "ON",
"bankAccount": {
"accountNumber": "90016666001",
"channelCode": "JENIUS"
},
"subAccountType": "KYC"
}Detail Parameter Request
name
String
1-255
M
Name of the Sub-account
shortName
String
1-25
M
Short Name of the Sub-account, used as the transaction descriptor
description
String
1-255
O
Description of the Sub-account
logo
String
1-255
M
URL of the Sub-account logo to be uploaded. Expecting a publicly accessible URL
merchantEmail
String
0-255
M
Email Address of the Sub-account
merchantPhone
String
1-255
M
Phone Number of the Sub-account
businessCountry
String
0-255
M
Two letter digits country code based on ISO 3166-1 alpha-2 where the business resides
businessType
String
1-20
M
Type of the business of sub-account, one of INDVIDUAL or COMPANY.
businessStructure
String
1-20
M
Business structure of the sub-merchants. e.g. CV, PT, etc.
Business structure is regulated differently in each Country.
digitalStatus
String
0-255
O
Selling Digital Product / Non-Digital Product, possible values are Digital or Non-digital
picName
String
1-32
M
PIC Full Name
picPhone
String
1-255
M
PIC phone number
picEmail
String
0-255
M
PIC email address
picJobTitle
String
1-20
O
PIC Job Title
address
String
1-254
M
Full Address of Sub-account's Company
postCode
String
1-20
M
Postal code of the Sub-account company address
autoWithdrawal
String
0-5
O
Options to enable/disable auto-withdrawal capability, default will be "ON"
bankAccount
Object
-
O
accountNumber
String
1-60
M
Account Number of Withdrawal destination
channelCode
String
1-60
M
Channel code for Withdrawal destination, such as Bank, E walle,t or other channels
The list of Channel codes can be accessed Channel Codes
subAccountType
String
0-10
O
Possible values are:
KYC
NON_KYC
The default value is NON_KYC
Response
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": "admin@corp.inc",
"merchantPhone": "081217003600",
"picEmail": "admin@corp.inc",
"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"
},
"subAccountStatus": "CREATED",
"subAccountType": "KYC",
"subAccountKycStatus": "WAITING_FOR_DOCUMENT"
}
}Detail Parameter Response
code
String
M
Response Code from Pivot
message
String
M
Human readable message that represent response from Pivot
Last updated