VOvopay
Bank Account Endpoints

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

post/bank-account/generate-embed-url

Request

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

ClientAccountIDstring

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

RedirectURLstring 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

CompanyNamestring

Name of the Company

Languagestring

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

RedirectMethodstring

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

AccountSelectionMethodstring

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

ClientControlledboolean

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

ClientReferenceNumberstring

An optional reference number to associate with the bank account.

TermsAndConditionsstring

Used to add your own terms and conditions

Countrystring

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

WithTransactionsboolean

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

RequireDebitAuthorityAgreementboolean

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

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

EmbedURLstring required

Custom generated iQ11 iframe url for users to use

IframeKeystring required

Unique key attached to the generated iFrame

Example response

{
  "Success": true,
  "EmbedURL": "https://earthnode-dev.vopay.com/visa_direct/embed/{Key Returned by Vopay}",
  "IframeKey": "a1b2c3"
}

Changes

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