search
Get StartedAccount and Balance ManagementPaymentsPayoutsAPI References

Create a Sub-account

Create a new sub-account

hashtag
Method and URL

POST [BASE_URL]/v1/sub-merchants

hashtag
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

Parameter
Data Type
Character Limit
Requirement
Description

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-2arrow-up-right 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.

parentIndustry

String

0-255

O

Industry in general Merchant Industry Listarrow-up-right

childIndustry

String

0-255

O

Industry in specific Merchant Industry Listarrow-up-right

mcc

String

0-255

O

Merchant Category Code MCC Code Listarrow-up-right

countryOfEntity

String

0-255

O

Merchant's operational Country ISO 3166-1 alpha-2arrow-up-right

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:

  1. KYC

  2. NON_KYC

The default value is NON_KYC

hashtag
Response

Response Body

Detail Parameter Response

Parameter
Data Type
Requirement
Description

code

String

M

Response Code from Pivot

message

String

M

Human readable message that represent response from Pivot

data

Object

M

Response Data from Pivot contains Sub-accounts Object

PreviousActivity on behalf-of Sub-accountNextAssign User to a Sub-account

Last updated