VoPay + Plaid Integration – Open Finance Payments Service

Our partnership with Plaid allows clients who have an existing account with Plaid to integrate with VoPay and take advantage of our open finance payment service. You can learn more here. With the VoPay API, users can initiate payments via EFT / ACH through a single implementation. VoPay’s solution supports the full cycle of money movement for growing businesses including payment initiation, approvals, monitoring, and reconciliation. As part of the integration, VoPay customers can utilize Plaid’s APIs for real-time payment initiation.

To enable this integration, you must configure your Plaid API and be aware of your:

  1. Plaid Client ID
  2. Plaid Secret Key
  3. PlaidUrl

Plaid should provide you with your own Plaid Client ID, Plaid Secret Key and PlaidUrl that uniquely defines your Plaid Integration. Once your VoPay account has been configured to use Plaid, you will be able to make API calls using a Plaid Public Token and Plaid Account ID instead of the bank account and institution numbers.

Getting Started

Firstly, you should familiarize yourself with Plaid Link, a drop-in integration for the Plaid API that handles input validation, error handling, and multi-factor authentication. Your customers will use Link to authenticate with their financial institution and select the bank account they wish to use for EFT / ACH transactions. From there, you’ll receive a plaid public token and plaid account ID, which allows you to quickly and securely verify a bank funding source via VoPay’s API without having to store any sensitive banking information. Utilizing VoPay + Plaid enables a seamless workflow for sending and receiving payments.

Instructions

Step 1: Set up your VoPay account

You’ll need accounts at both VoPay and Plaid in order to use the VoPay + Plaid integration. 

First, you will need to work with the VoPay team to sign up for a VoPay account, if you do not already have one.

Next, verify that your Plaid account is enabled for the integration. If you do not have a Plaid account, please contact our onboarding team to create one.

To verify that your Plaid account is enabled for the integration, you need to make an API request to the endpoint that you can find in the VoPay Plaid Configuration documentation section. 

If the integration is not configured, simply make a request to the endpoint given in the VoPay Plaid Configuration section to enable the configuration.

Once your integration is configured, simply follow the workflow to get things going. Existing Plaid Customers should add VoPay as a teammate in their Plaid client dashboard in order to distribute API Keys / Credentials to our onboarding team.

Step 2: Integrate with Plaid Link

There are two general workflows for Plaid-enabled integration with iQ11:

  1. Processor Token – For clients with an existing integration with Plaid or who plan to use the Plaid APIs directly. In addition, to processing transactions through VoPay, This is the recommended approach.
  2. Public Token – For clients who wish to have VoPay handle all interactions with Plaid. This is a slightly simpler integration, but you lose the ability to use the Plaid APIs directly.

Workflow 1: Processor Token

With the Processor Token approach, you are responsible for exchanging the Public Token for an Access Token. When you wish to initiate a transaction, you will call Plaid’s API to create a Processor Token from your Access Token.

The full step-by-step process after you receive the Public Token and Account ID from the Plaid iframe is as follows:

  1. Within 30 minutes you exchange the Plaid Public Token you received for an Access Token by calling Plaid’s endpoint /item/public_token/exchange. Please visit the link here: https://plaid.com/docs/api/tokens/#itempublic_tokenexchange
  2. Once you successfully receive the AccessToken you need to generate the Processor Token by calling Plaid’s endpoint processor/token/create. Please visit the link here: https://plaid.com/docs/api/processors/#processortokencreate
  3. You make an API call to the desired EFT endpoint, providing the PlaidProcessorToken instead of account number, transit number, and financial institution number.
  4. iQ11 fetches the account number, transit number, and financial institution number for the specified Plaid Processor token and uses that to process the EFT transaction.

Workflow 2: Public Token

With the Public Token approach, VoPay will handle all interactions with Plaid. 

The full step-by-step process after you receive the Public Token and Account ID from the Plaid iframe is as follows:

  1. Navigate the user to the Plaid login screen, typically using your Plaid iframe.
  2. The User selects their preferred financial institution from the iFrame.
  3. The User logs in to their online banking account.
  4. Users select the account they wish to use.
  5. Plaid returns the Plaid Public Token and Account ID to you.
  6. Within 30 minutes you make an API call to the desired VoPay EFT endpoint, providing the Plaid Public Token and Plaid Account ID instead of the account number, transit number, and financial institution number.
  7. iQ11 fetches the account number, transit number, and financial institution number for the specified Plaid Account ID and uses that to process the EFT 

Note: with this approach you will NOT receive an AccessToken, and will be unable to directly call any Plaid APIs which require an AccessToken.

Important Note: To use the Plaid integration, you need to configure your Plaid connection with the endpoint account/set-plaid-credentials. After this step you will be able to connect successfully.

VoPay account configuration for Plaid

To configure your VoPay account to use Plaid, use the following endpoint.

account/set-plaid-credentials

This method is used to set up the Plaid credentials to use Plaid on EFT.

Request Parameters

NameTypeRequiredNotes
AccountIDStringYYour account ID
KeyStringYAPI key for the account
SignatureStringYHashed signature for the request
PlaidClientIDStringYThe unique client ID from Plaid
PlaidSecretKeyStringYThe unique secret key Plaid
PlaidUrlStringYThe URL defines the Plaid environment. For example  https://sandbox.plaid.com for sandbox, https://development.plaid.com for development, and https://production.plaid.com for production.

Response Parameters

NameTypeNotes
SuccessBoolTrue if the request was successful, false if it failed
ErrorMessageStringContains a description of the error if the request failed
PlaidClientIDStringYour updated plaid client ID
PlaidSecretKeyStringYour updated plaid secret key
PlaidUrlStringYour updated plaid URL

Once your VoPay account is configured with Plaid, you will be able to use it to make payments using our EFT Fund and EFT Withdraw API endpoints.

Support

Have a question? See our FAQ or contact our support team. We look forward to helping you digitize online bank payments with ease.

Get to know the VoPay API

Get access to our developer friendly API and get a feel for how our payment solutions work.

I agree to the VoPay API Terms of Use.

Request a Call

Talk with our sales team

We are happy to answer your questions. Fill out the form and we will have one of our team members contact you.