VOvopay
ACH Endpoints

ach/withdraw

This endpoint is used to send funds to a specified customer's US Bank account. In the endpoint below, either CompanyName OR FirstName and LastName must be provided.

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

post/ach/withdraw

Request

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

IdentificationNumberstring required

Customer's driver's licence (individuals) or federal tax ID (companies).

EmailAddressstring required

Customer's email address

PhoneNumberstring required

Customer's phone number. Digits only - no parentheses or dashes allowed.

Address1string required

Customer's address line 1

Address2string

Customer's address line 2

Citystring required

Customer's city

Statestring required

Customer's state specified using two character abbreviations (eg. CA, AZ)

Countrystring required

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

ZipCodestring required

Customer's zip code.

IPAddressstring

Customer's IP address.

ABARoutingNumberinteger required

ABA routing transit number for customer's US bank account.

AccountNumberinteger required

Account number for the customer's US bank account

Amountnumber required

The amount to credit to the customer's bank account.

Tokenstring

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

PlaidProcessorTokenstring

Used by clients with a Plaid account. When this is provided, the routing number and account number are not required.

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.

ClientReferenceNumberstring

A reference number to use to search the transaction. Must provide either a TransactionID or ClientReferenceNumber.

ParentTransactionIDstring

The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.

GLCodestring

An optional unique identification general ledger code.

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).

SecCodestring

The ACH Standard Entry Class (SEC) code. Defaults to PPD if not specified.

TransactionLabelstring

TransactionLabel overrides originator short name

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.

Example response

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

Changes

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