---
title: "bank-account/generate-embed-url"
method: POST
path: "/bank-account/generate-embed-url"
tags: ["Bank Account Endpoints"]
---

# bank-account/generate-embed-url

`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

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](https://docs.vopay.com/docs/iq11-overview)

## Request body `application/x-www-form-urlencoded`

- object
  - `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`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `EmbedURL` string, required: Custom generated iQ11 iframe url for users to use
  - `IframeKey` string, required: Unique key attached to the generated iFrame

---

[API](https://skmtc.dev/vopay/apis/payment-methods.md) - [All operations](https://skmtc.dev/vopay/apis/payment-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-methods/revisions/b566c8002410?raw)