partner/account

post

https://earthnode-dev.vopay.com/api/v2/partner/account

This endpoint is used to create a VoPay account. You will need to sign-up as a partner account in order to use this endpoint and start creating VoPay accounts for your users.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

Name

string

required

Name of the person/company you are going to create an account for. When creating a sub account (ParentAccountID provided), this is the DBA name and is stored as the DBA name when it differs from LegalBusinessName. If LegalBusinessName is omitted, Name is used as the legal name.

LegalBusinessName

string

The legal business name, used as the account name. If omitted, Name is used.

EmailAddress

string

required

Email address of the person/company you are creating an account for

Country

string

This is an opetional parameter specifying the country of the account. ISO abbreviation or full country name. If not provided, the account will inherit the country of the partner account.

ClientAccountsEnabled

boolean

This is an optional parameter to enable client accounts

ParentAccountID

string

Specify the parent account ID to create a sub account under this parent account. The parent may be an account in your book or, when partner account creation is enabled, an account in a child partner's book. It must be active and have sub-accounts enabled. When provided, Country is ignored and the parent account's country is used. Partner portal (JWT) callers must have the Admin role to create a sub account.

CreateVirtualAccount

boolean

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.

VopayAccountID

string

Optional custom account ID to assign to the new account being created

PrimaryContactName

string

Full name of the primary contact for the account

Address1

string

Street address line 1 for the account

Address2

string

Street address line 2 for the account

City

string

City of the account address

Province

string

Province or state of the account address

PostalCode

string

Postal or ZIP code of the account address

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200