iq11/tokenize

post

https://earthnode-dev.vopay.com/api/v2/iq11/tokenize

This endpoint allows you to submit payment method details (bank account, email address), and will return a token which can be used to perform transactions.

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

Client Account ID

AccountHolderName

string

String that defines the account holder name. Used for all payment methods.

AccountNumber

string

Customer's bank account number.

FinancialInstitutionNumber

string

Three digit institution number for a Canadian bank account.

BranchTransitNumber

string

Five digit branch transit number for a Canadian bank account.

ABARoutingNumber

string

Nine digit ABA Routing number of a US bank account.

FlinksAccountID

string

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

FlinksLoginID

string

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

PlaidProcessorToken

string

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

MxProcessorToken

string

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

Currency

string

Three letter currency code.

Address1

string

First line of the address. Ex: 123 Main St.

City

string

City

State

string

State

ZipCode

string

Zip code

Province

string

Province

PostalCode

string

Postal code

Country

string

Two letter country code.

VerifyAccount

boolean

When set to true, the connected bank account will be verified. Default is false. Only applicable when Flinks or Plaid credentials are provided.

EmailAddress

string

Email address

PhoneNumber

string

Phone number

Question

string

Security question (used for Interac transactions)

Answer

string

Security answer (used for Interac transactions)

Language

string

Language - en (English) or fr (French). Default value is en (English)

Message

string

Message sent to recipient (used for Interac)

ClientControlled

boolean

When set to true, the connected bank account will be linked to your VoPay account. Default is false.

ClientReferenceNumber

string

An optional reference number to associate with the bank account.

Type

string

The type of payment method you are tokenizing. Valid values are: 'bank', 'email'. Default is 'bank'.

Response

200