VOvopay
EFT Endpoint

eft/fund

This endpoint is used to fund your VoPay account by debiting funds from the specified customer's bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided.

If either Token, Flinks (FlinksAccountID, FlinksLoginID), Inverite (InveriteRequestGUID), or Plaid (PlaidPublicToken/PlaidAccessToken, PlaidAccountID) is provided, the FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber will not be required.

If the bank information is provided (FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber), then the Address1, City, Country, and PostalCode and Province are required.

If a ClientAccountID is provided, the client account's first/last name, address, and default bank account will be used for the transaction.

post/eft/fund

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/eft/fund
  • 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

Client Account ID

ContactIDstring

The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.

FirstNamestring required

Customer's first name

LastNamestring required

Customer's last name

CompanyNamestring required

Company's name

Address1string required

Customer's address line 1

Citystring required

Customer's city

Provincestring required

Customer's province specified using two character abbreviations (eg. BC, AB)

Countrystring required

Customer's country specified using full country name or ISO 3166-1 alpha-2 code.

PostalCodestring required

Customer's postal code.

AccountNumberstring required

Customer's bank account number for funds to be debited from.

FinancialInstitutionNumberstring required

Three digit institution number for a Canadian bank.

BranchTransitNumberstring required

Transit number for the customer's account.

Amountnumber required

The amount to debit from the customer's bank account.

Currencystring required

3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency. NOTE: Currently the eft/fund API endpoint only supports CAD and USD transactions.

Iq11VerificationLevelIDinteger

Iq11 verification level ID. Accepted values are: 1 (no NSF check), 2 (NSF check done at time of transaction), 3 (NSF check done prior to processing the transaction), and 4 (NSF check done at the time of transaction and prior to processing the transaction). Value is defaulted to the default value set on the account.

ClientReferenceNumberstring

An optional reference number to associate with the transaction.

FlinksAccountIDstring

Used by clients with a Flinks account

FlinksLoginIDstring

Used by clients with a Flinks account

Tokenstring

Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.

PlaidPublicTokenstring

Used by clients with a Plaid account

PlaidAccessTokenstring

Used by clients with a Plaid account

PlaidAccountIDstring

Used by clients with a Plaid account

PlaidProcessorTokenstring

Used by clients with a Plaid account. If you use this field PlaidPublicToken, PlaidAccessToken, and PlaidAccountID are not neccesary

MxAuthorizationCodestring

Used by clients with an MX account.

InveriteRequestGUIDstring

Used by clients with an Inverite account

TransactionTypeCodestring

CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).

TransactionLabelstring

TransactionLabel overrides originator short name

Notesstring

An optional note to associate with the transaction.

IdempotencyKeystring

A unique key which the server can use to recognize and reject subsequent retries of the same request.

GLCodestring

An optional unique identification general ledger code.

WalletIDstring

The ID of the wallet to associate with the transaction. Requires ClientAccountID to be provided.

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

TransactionIDinteger required

This ID should be saved as it is required in order to look up status information on the transaction.

Flaggedstring

Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.

Iq11boolean required

True if the transaction was an iq11 transaction, false if it is not.

Example response

{
  "Success": true,
  "Flagged": "The transaction has been flagged as a potential duplicate.",
  "Iq11": true
}

Changes

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