bank-account/generate-embed-url

post

https://earthnode-dev.vopay.com/api/v2/bank-account/generate-embed-url

This endpoint is used to generate a unique URL to embed into your application using an iFrame. End users will use this to log in to their online banking and select a bank account to make a payment from. For additional details on iQ11 and RedirectMethod, please visit our Iq11 Overview

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

When provided, the bank account submitted will be attached to the Client Account ID

RedirectURL

string

required

URL to redirect to after the customer logs in to their online banking account. The bank account token will be passed as a GET parameter, for example https://redirect.com/page?Token=1234

CompanyName

string

Name of the Company

Language

string

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

RedirectMethod

string

This parameter accepts InnerRedirect, OuterRedirect, and JavascriptMessage as parameter values.

AccountSelectionMethod

string

This parameter accepts any, online and manual as parameter values. Defaults to any.

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.

TermsAndConditions

string

Used to add your own terms and conditions

Country

string

This parameter accepts country codes [CA, US]. Default is CA

WithTransactions

boolean

Request transaction history when connecting a bank account online. Default is false.

RequireDebitAuthorityAgreement

boolean

This parameter will determine if we display a debit authority agreement to the end-user before the connect their payment method. You must request this feature to be enabled for your account. Default is true.

Response

200