---
updatedAt: 2026-04-23T04:16:37.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# account/subaccount

This endpoint is used to create a new sub-account.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Accounts",
    "description": "The Account API defines endpoints for managing VoPay accounts and sub-accounts.  These endpoints allow partners to create and manage accounts, set permissions, handle transactions,  schedule transfers, retrieve account information, and manage onboarding processes, ensuring secure  and efficient account and transaction management.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/account/subaccount": {
      "post": {
        "description": "This endpoint is used to create a new sub-account.",
        "summary": "account/subaccount",
        "tags": [
          "Sub-Account Endpoints"
        ],
        "operationId": "SubaccountPOST",
        "deprecated": false,
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "AccountID": {
                    "description": "Your account ID",
                    "type": "string"
                  },
                  "Key": {
                    "description": "API key for the account",
                    "type": "string"
                  },
                  "Signature": {
                    "description": "Hashed signature for the request",
                    "type": "string"
                  },
                  "LegalBusinessName": {
                    "description": "Company's Legal business name",
                    "type": "string"
                  },
                  "EmailAddress": {
                    "description": "Company's email address - Must be a valid email",
                    "type": "string",
                    "format": "email"
                  },
                  "SendWelcomeEmail": {
                    "description": "It is a flag to allow user to decide if he wants to send the welcome email on their behalf or not. By default this value is set as true",
                    "type": "boolean"
                  },
                  "SubaccountID": {
                    "description": "The account ID of the subaccount. If not provided, it will be defaulted to a random string generated by our system",
                    "type": "string"
                  },
                  "CreateVirtualAccount": {
                    "description": "It is a flag to allow user to decide if he wants to create a virtual account for the subaccount. By default this value is set as true. Must have VirtualAccounts enabled to use this parameter.",
                    "type": "boolean"
                  },
                  "PrimaryContactName": {
                    "description": "Full name of the primary contact for the account",
                    "type": "string"
                  },
                  "Address1": {
                    "description": "Street address line 1 for the account. Inherited from the parent account if not provided.",
                    "type": "string"
                  },
                  "Address2": {
                    "description": "Street address line 2 for the account. Inherited from the parent account if not provided.",
                    "type": "string"
                  },
                  "City": {
                    "description": "City of the account address. Inherited from the parent account if not provided.",
                    "type": "string"
                  },
                  "Province": {
                    "description": "Province or state of the account address. Inherited from the parent account if not provided.",
                    "type": "string"
                  },
                  "PostalCode": {
                    "description": "Postal or ZIP code of the account address. Inherited from the parent account if not provided.",
                    "type": "string"
                  },
                  "Country": {
                    "description": "Country of the account address. Inherited from the parent account if not provided. ISO abbreviation or full country name.",
                    "type": "string"
                  }
                },
                "required": [
                  "AccountID",
                  "Key",
                  "Signature",
                  "LegalBusinessName",
                  "EmailAddress"
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Success": {
                      "type": "boolean",
                      "description": "True if the request was successful, false if it failed",
                      "example": true
                    },
                    "ErrorMessage": {
                      "type": "string",
                      "description": "Contains a description of the error if the request failed",
                      "example": ""
                    },
                    "Message": {
                      "type": "string",
                      "description": "Contains a description of the successful message",
                      "example": ""
                    },
                    "AccountID": {
                      "type": "string",
                      "description": "Account Name of the new user created in the endpoint",
                      "example": "AccountTest1"
                    },
                    "APISharedSecret": {
                      "type": "string",
                      "description": "API Shared Secret",
                      "example": "AbcDefGi+KlmnopQRSTu183=="
                    },
                    "APIKey": {
                      "type": "string",
                      "description": "The API key for the sub account",
                      "example": "eddc0f5e37d20f98b486daf842447ec1f225f859"
                    }
                  },
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "Message",
                    "AccountID",
                    "APISharedSecret",
                    "APIKey"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```