> For the complete documentation index, see [llms.txt](https://pivot-payment.gitbook.io/pivot-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/create-a-sub-account.md).

# Create a Sub-account

## Method and URL

<mark style="color:green;">`POST`</mark> \[<mark style="color:orange;">BASE\_URL</mark>]/v1/sub-merchants

## Request

**Request Body**

```json
{
  "name": "Reforza Corporation",
  "shortName": "RCI",
  "description": "Whale Technology Company",
  "website": "pivot-payment.com",
  "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",
  "picInvitation": false,
  "address": "H Rasuna Said, Jakarta",
  "districtId": 1970,
  "postCode": "10230",
  "autoWithdrawal": "ON",
  "bankAccount": {
    "accountNumber": "90016666001",
    "channelCode": "JENIUS"
  },
  "subAccountType": "KYC"
}
```

**Detail Parameter Request**

<table data-full-width="false"><thead><tr><th width="224">Parameter</th><th>Data Type</th><th>Character Limit</th><th width="129.78515625">Requirement</th><th width="304">Description</th></tr></thead><tbody><tr><td>name</td><td>String</td><td>1-255</td><td>M</td><td>Name of the Sub-account</td></tr><tr><td>shortName</td><td>String</td><td>1-25</td><td>M</td><td>Short Name of the Sub-account, used as the transaction descriptor</td></tr><tr><td>description</td><td>String</td><td>1-255</td><td>O</td><td>Description of the Sub-account</td></tr><tr><td>website</td><td>Strin</td><td>-</td><td>M</td><td>Website URL of the Sub-account</td></tr><tr><td>logo</td><td>String</td><td>1-255</td><td>M</td><td>URL of the Sub-account logo to be uploaded. Expecting a publicly accessible URL</td></tr><tr><td>merchantEmail</td><td>String</td><td>0-255</td><td>M</td><td>Email Address of the Sub-account</td></tr><tr><td>merchantPhone</td><td>String</td><td>1-255</td><td>M</td><td>Phone Number of the Sub-account</td></tr><tr><td>businessCountry</td><td>String</td><td>0-255</td><td>M</td><td>Two letter digits country code based on <a href="https://en.wikipedia.org/wiki/ISO_3166-1">ISO 3166-1 alpha-2</a> where the business resides</td></tr><tr><td>businessType</td><td>String</td><td>1-20</td><td>M</td><td>Type of the business of sub-account, one of <mark style="color:orange;"><code>INDVIDUAL</code></mark> or <mark style="color:orange;"><code>COMPANY</code></mark>. </td></tr><tr><td>businessStructure</td><td>String</td><td>1-20</td><td>M</td><td><p>Business structure of the sub-merchants. e.g. CV, PT, etc. </p><p></p><p>Business structure is regulated differently in each Country.</p></td></tr><tr><td>parentIndustry</td><td>String</td><td>0-255</td><td>M</td><td>Industry in general<br><a data-mention href="/pages/mZgCQWSro9QdxUwYVcMl">/pages/mZgCQWSro9QdxUwYVcMl</a></td></tr><tr><td>childIndustry</td><td>String</td><td>0-255</td><td>M</td><td>Industry in specific<br><a data-mention href="/pages/mZgCQWSro9QdxUwYVcMl">/pages/mZgCQWSro9QdxUwYVcMl</a></td></tr><tr><td>mcc</td><td>String</td><td>0-255</td><td>M</td><td>Merchant Category Code<br><a data-mention href="/pages/mZgCQWSro9QdxUwYVcMl">/pages/mZgCQWSro9QdxUwYVcMl</a></td></tr><tr><td>countryOfEntity</td><td>String</td><td>0-255</td><td>M</td><td>Merchant's operational Country<br><a href="https://en.wikipedia.org/wiki/ISO_3166-1">ISO 3166-1 alpha-2</a></td></tr><tr><td>digitalStatus</td><td>String</td><td>0-255</td><td>M</td><td>Selling Digital Product / Non-Digital Product, possible values are <mark style="color:orange;"><code>Digital</code></mark> or <mark style="color:orange;"><code>Non-digital</code></mark></td></tr><tr><td>picName</td><td>String</td><td>1-32</td><td>M</td><td>PIC Full Name</td></tr><tr><td>picPhone</td><td>String</td><td>1-255</td><td>M</td><td>PIC phone number</td></tr><tr><td>picEmail</td><td>String</td><td>0-255</td><td>M</td><td>PIC email address</td></tr><tr><td>picJobTitle</td><td>String</td><td>1-20</td><td>O</td><td>PIC Job Title</td></tr><tr><td>picInvitation</td><td>Boolean</td><td>-</td><td>O</td><td>Invite PIC to Dashboard, default value is <mark style="color:orange;"><code>false</code></mark></td></tr><tr><td>address</td><td>String</td><td>1-254</td><td>M</td><td>Full Address of Sub-account's Company</td></tr><tr><td>districtId</td><td>Number</td><td>-</td><td>M</td><td><a data-mention href="/pages/mZgCQWSro9QdxUwYVcMl">/pages/mZgCQWSro9QdxUwYVcMl</a></td></tr><tr><td>postCode</td><td>String</td><td>1-20</td><td>M</td><td>Postal code of the Sub-account company address</td></tr><tr><td>autoWithdrawal</td><td>String</td><td>0-5</td><td>O</td><td>Options to enable/disable auto-withdrawal capability, default will be "ON"</td></tr><tr><td>bankAccount</td><td>Object</td><td>-</td><td>O</td><td></td></tr><tr><td><ul><li>accountNumber</li></ul></td><td>String</td><td>1-60</td><td>M</td><td>Account Number of Withdrawal destination</td></tr><tr><td><ul><li>channelCode</li></ul></td><td>String</td><td>1-60</td><td>M</td><td><p>Channel code for Withdrawal destination, such as Bank, E walle,t or other channels</p><p></p><p>The list of Channel codes can be accessed <a data-mention href="/pages/VLaKKcjXG5xkE8l7BiiC">/pages/VLaKKcjXG5xkE8l7BiiC</a></p></td></tr><tr><td>subAccountType</td><td>String</td><td>0-10</td><td>O</td><td><p>Possible values are:</p><ol><li>KYC</li><li>NON_KYC</li></ol><p></p><p>The default value is <mark style="color:orange;"><code>NON_KYC</code></mark></p></td></tr></tbody></table>

## Response

**Response Body**

{% code fullWidth="false" %}

```json
{
  "code": "00",
  "message": "Success",
  "data": {
    "uuid": "d8361719-290b-4b80-8e75-8329321a4000",
    "name": "Reforza Corporation",
    "shortName": "RCI",
    "description": "Whale Technology Company",
    "website": "pivot-payment.com",
    "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"
  }
}
```

{% endcode %}

**Detail Parameter Response**

<table><thead><tr><th>Parameter</th><th width="136.9600830078125">Data Type </th><th width="135.126708984375">Requirement</th><th>Description</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>M</td><td>Response Code from Pivot</td></tr><tr><td>message</td><td>String</td><td>M</td><td>Human readable message that represent response from Pivot</td></tr><tr><td>data</td><td>Object</td><td>M</td><td>Response Data from Pivot contains <a data-mention href="/pages/DapgzASTsSP7NRslMjME">/pages/DapgzASTsSP7NRslMjME</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://pivot-payment.gitbook.io/pivot-docs/api-references/api-lists/account-and-balance/sub-account-management/create-a-sub-account.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
