account/client-accounts/receive-only

post

https://earthnode-dev.vopay.com/api/v2/account/client-accounts/receive-only

Use this endpoint to create a new receive-only client account. If Flinks, Plaid or Mx credentials are provided, we will fetch all personal and bank account details from those providers. Otherwise, must provide either FirstName/LastName or BusinessName

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

ClientAccountID

string

Custom ID of the client account you want to create

FirstName

string

Client's first name

LastName

string

Client's last name

BusinessName

string

Client's business name

EmailAddress

string

required

Client's email address - Must be a valid email

Address1

string

Client's address line 1

City

string

Client's city

Province

string

Client's province specified using two character abbreviations (eg. BC, AB)

Country

string

Client's country specified using full country name or ISO 3166-1 alpha-2 code. If not provided, we will default to the VoPay account's country.

Nationality

string

Client's nationality specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

PostalCode

string

Client's postal code.

Currency

string

required

3-character currency code defined by the ISO-4217 standard (e.g. CAD, USD). Used to set the default currency used by this client account. Can be CAD or USD for Canadian accounts. Must be set to USD for US accounts.

PhoneNumber

string

required

Client's phone number. Digits only - no parentheses or dashes allowed.

IdentificationNumber

string

Client's driver's licence.

Token

string

An iQ11 Token that has been generated using Custom Iframe.

Label

string

This option will add a Label to the client account. If the Label doesn't exist it will be created and applied.

FlinksAccountID

string

Flinks Account ID. Must be accompanied by a FlinksLoginID. VoPay will fetch the associated user and bank account details from Flinks.

FlinksLoginID

string

Flinks Login ID. Must be accompanied by a FlinksAccountID. VoPay will fetch the associated user and bank account details from Flinks.

PlaidProcessorToken

string

Plaid Processor Token. VoPay will fetch the associated user bank account details from Plaid.

MxProcessorToken

string

Mx Processor Token. VoPay will fetch the associated user bank account details from Mx.

Response

200