VOvopay
Partner Endpoints

partner/account

Changed on

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.

post/partner/account

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/account
  • 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

Namestring 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.

LegalBusinessNamestring

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

EmailAddressstring email required

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

Countrystring

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.

ClientAccountsEnabledboolean

This is an optional parameter to enable client accounts

ParentAccountIDstring

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.

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.

VopayAccountIDstring

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

PrimaryContactNamestring

Full name of the primary contact for the account

Address1string

Street address line 1 for the account

Address2string

Street address line 2 for the account

Citystring

City of the account address

Provincestring

Province or state of the account address

PostalCodestring

Postal or ZIP code of the account address

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

ApplicationIDstring required

The onboarding application ID. Only applicable if the account is created in 'Application Pending' status

Linkstring required

The onboarding application link. Only applicable if the account is created in 'Application Pending' status

Example response

{
  "Success": true,
  "AccountID": "AccountTest1",
  "APISharedSecret": "AbcDefGi+KlmnopQRSTu183==",
  "APIKey": "eddc0f5e37d20f98b486daf842447ec1f225f859",
  "ApplicationID": "213086325897",
  "Link": "https://onboarding-app-dev.vopay.com"
}

Changes