iq11/generate-embed-url

post

https://earthnode-dev.vopay.com/api/v2/iq11/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

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. If not provided, RedirectMethod defaults to javascriptmessage.

CompanyName

string

Name of the Company. Defaults to the account name if not provided.

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. Defaults to innerredirect if RedirectURL is provided, otherwise javascriptmessage.

AccountSelectionMethod

string

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

PaymentSelectionMethod

string

This parameter accepts any, bank, email, credit, debitcard, googlepay, applepay, paypal, or venmo 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.

Country

string

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

RequireDebitAuthorityAgreement

boolean

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

Verify

string

A comma-separated list of payment methods to verify once the user has connected their payment method. Allowed values are: 'bank', 'interacbasic', 'interacenhanced', 'cardbasic', 'cardenhanced'. If no value is provided, no verification will be performed.

CardTypeValidation

boolean

When set to true, the card type will be validated to ensure the entered information represents the selected card option. Default is false.

Trigger3DS

boolean

When set to true, 3DS authentication will be triggered during the card addition process. Default is false.

AcceptedCardBrands

string

A comma-separated list of accepted card brands to restrict which cards can be added.

AccountHolderType

string

enum

The type of account holder. Used to restrict the type of bank account that can be connected.

Allowed:

DarkMode

boolean

When set to true, the iFrame will be displayed in dark mode. Default is false.

Response

200