Sub-Accounts

A sub-account is owned by a verified user and tied directly to a master account on VoPay’s platform that can act like a “wallet” for holding a stored value of CAD or USD funds.

Sub-accounts are developed to work independently; ie, each sub-account has its own separate balance and the ability to send and receive money, get reports, and process batches. The master account is able to generate reports per sub-account and all their sub-accounts.

📘
Important
The option to generate sub-accounts will only be available for clients that have signed a Sub-Account Agreement. This permission will be granted by the VoPay administrator.

How to start

The first step is to ensure that you have all the right permissions to set up and operate Sub-Accounts. If you are not sure or you don't know, please submit a support ticket through the VoPay portal.

Once you have confirmed that you have permission to create sub-accounts, please continue with the following:

To create and submit a sub-account request, you need to use the endpoint 'POST account/subaccount'. At this point, the user should provide the Account ID, Key, and Signature to authenticate themselves, plus the minimal information that we require to create a new sub-account.

$ch = curl_init();
	curl_setopt($ch, CURLOPT_URL, "https://earthnode-dev.vopay.com/api/v2/account/subaccount");
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
	curl_setopt($ch, CURLOPT_POSTFIELDS, array(
		"AccountID" => "myaccount",
		"Key" => "aae103d7a897358a65afeee30720f000f6d8eb6a",
		"Signature" => "aae103d7a897358a65afeee30720f000f6d8eb6a",
		"LegalBusinessName" => "Subaccount Legal Business Name",
		"AccountName" => "SubaccountName1",
	  	"EmailAddress" => "[email protected]",
	));
	curl_exec($ch);

Once the information is sent, the system will return the API shared secret, API Key, and the Account ID. With the API shared secret and API Key, you can generate the signature and log in as a sub-account to send the rest of the required information and finalize your sub-account creation successfully.

{
    "Success": "true",
    "Message": "Your sub-account has been created successfully",
    "AccountID": "SubaccountName1",
    "APISharedSecret": "LkZk+Ko3ocyGzZmPKm==",
    "APIKey": "0eab3450c5f5509212612ecef3056fe4f0505783"
}

Complete the required information

There are several fields that you have to complete in order to have your sub-account setup and running. These fields need to be completed in the endpoint: account/subaccount/submit-extended-info

Field Name	Type	Description
OriginatorName	string	Short Name of the company (max 15 characters)
Address	string	Company’s address line 1
City	string	Company’s city - No abbreviation
Province	string	Company’s province Ie. British Columbia, Alberta, etc.
PostalCode	string	Company’s postal code
Country	string	Company’s country. Ie. Canada
PhoneNumber	integer	Company’s phone number
Fax	integer	Company’s fax number
EmailAddress	string	Company’s email address - Must be a valid email
NatureofBusiness	string
OrganizationalType	string	Ie. Private Limited Company, Sole Trader, Unincorporated Partnership, Incorporated Partnership, Public Limited Company, Registered Charity, Trust, Other
RegistrationNumber	integer	Registration’s registration number
JurisdictionNumber	integer	Registration’s jurisdiction number
RegistrationProvince	string	Registration’s province name
DateofIncorporation	string	Format (yyyy-mm-dd) - Registration Information
ShareholderFullName	string	Shareholder First name and last name
ShareholderOwnership	integer	Percentage of ownership only if is greater than 20%
ShareholderOccupation	string	Shareholder’s occupation
ShareholderHomeAddress	string	Shareholder’s home address
AuthorizedFullLegalName	string	Signing Authority and authorized representative - first name and last name
AuthorizedOccupation	string	Signing Authority and authorized representatives - occupation

For more information, please visit our API Documentation.

📘Important

How to start

Complete the required information

📘
Important