VOvopay
Sub-Account Endpoints

account/subaccount

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

post/account/subaccount

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/subaccount
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

LegalBusinessNamestring required

Company's Legal business name

EmailAddressstring email required

Company's email address - Must be a valid email

SendWelcomeEmailboolean

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

SubaccountIDstring

The account ID of the subaccount. If not provided, it will be defaulted to a random string generated by our system

CreateVirtualAccountboolean

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.

PrimaryContactNamestring

Full name of the primary contact for the account

Address1string

Street address line 1 for the account. Inherited from the parent account if not provided.

Address2string

Street address line 2 for the account. Inherited from the parent account if not provided.

Citystring

City of the account address. Inherited from the parent account if not provided.

Provincestring

Province or state of the account address. Inherited from the parent account if not provided.

PostalCodestring

Postal or ZIP code of the account address. Inherited from the parent account if not provided.

Countrystring

Country of the account address. Inherited from the parent account if not provided. ISO abbreviation or full country name.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Messagestring required

Contains a description of the successful message

AccountIDstring required

Account Name of the new user created in the endpoint

APISharedSecretstring required

API Shared Secret

APIKeystring required

The API key for the sub account

Example response

{
  "Success": true,
  "AccountID": "AccountTest1",
  "APISharedSecret": "AbcDefGi+KlmnopQRSTu183==",
  "APIKey": "eddc0f5e37d20f98b486daf842447ec1f225f859"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.