Commonly Used Endpoints

Create a wallet (client account) for your customer that allows you to partition transactions and hold funds in a virtual entity

account/client-accounts/individual

Creates an individual (or business) client account which is subsequently used for transaction operations

Take note of ClientAccountID you get in response. Use this to identify your customer uniquely

Generate an embedded experience (iFrame) that can be presented to an end user allowing them to add a payment method like a bank account or card

iq11/generate-embed-url

Generates a unique URL to embed into your application as an iFrame. End users will use this experience to connect their bank account or card which is then tokenized and returned to you.

Pass in the ClientAccountID with request, so the bank account is associated to the client. Take note of the token you receive in the response, as this will be unique token for the connected payment method for that client

Set the given bank account as the default

account/set-my-bank-account

Associates the bank account associated with a token as the default bank account either for a VoPay account or for a client account

In the case of setting this as a default bank account for a client, provide the unique ClientAccountID for the client and pass SetAsDefault = true

Get all bank accounts for a client

bank-account

Lists all bank accounts and get additional details for these bank accounts

Pass in the ClientAccountID to get list of all bank accounts for a client. Pass in the ClientAccountID and Token to get details of a specific bank account for the client

Create a pull EFT transaction

eft/fund

Funds your VoPay account by debiting funds from the specified customer’s bank account

When specifying a ClientAccountID, funds will move from a bank account to the associated Client Account. Otherwise, funds will be pulled in to your VoPay balance.
You may specify a bank account using the bank account details or via a VoPay or data aggregator processor token

Create a push EFT transaction

eft/withdraw

Sends funds to a client using the balance in your VoPay account

When specifying a ClientAccountID, funds will move from the associated Client Account to a bank account. Otherwise, funds will be withdrawn from your VoPay balance