VOvopay
Account Verification Endpoints

account-verification/bank-account/initiate

This endpoint is used to intiate the micro deposit transaction. The bank routing information required will vary depending on the country. Currently only US and Canada are supported.

post/account-verification/bank-account/initiate

Request

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

Countrystring required

Country for which the Micro Transaction should be initiated

CompanyNamestring required

Company name of the account holder - required for associating the bank details

FirstNamestring required

First name of the account holder - required for associating the bank details (optional if company name is present)

LastNamestring required

Last name of the account holder - required for associating the bank details (optional if company name is present)

Notesstring

An optional note to associate with the account verification request.

ClientReferenceNumberstring

Reference number for the client

InstitutionNumberstring

Financial Institution number - required for associating the bank details. Canada only.

TransitNumberstring

Bank transit number - required for associating the bank details. Canada only.

AccountNumberstring required

Account number - required for associating the bank details.

ABARoutingNumberstring

ABA routing number - required for associating the bank details. US only.

SendEmailboolean

This option is used to send the account verification initiation/expiration email. If you wish to send an email, then provide true. The default value is false.

SenderEmailAddressstring email

Account's email address - Must be a valid email. Required if SendEmail = true

ReceiverEmailAddressstring email

Recipient's email address - Must be a valid email. Required if SendEmail = true

PhoneNumberstring

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

Address1string

Customer's address line 1. US only.

Citystring

Account's city - No abbreviation. US only.

Statestring

Customer's state specified using two character abbreviations (eg. CA, AZ). US only.

ZipCodestring

Customer's zip code. US only.

Tokenstring

The token identifying the bank account to be verified. If token is provided, bank routing info and address are not required.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

VerificationRequestIDinteger

Verification Request ID for the Bank Account to be verified

Linkstring

Link associated with the Account Verification Request ID

Example response

{
  "Link": "https://embed.vopay.com/rtzcel1puxjd2ppyg3vlujggk2u52hzcv99eso14"
}

Changes

No recorded changes to this operation across all 1 revision of this API.