VOvopay
Wire Endpoints

wire/withdraw

This endpoint sends a wire. The wire rail is detected from the beneficiary bank identifiers supplied (or stored on the bank account behind a Token / ClientAccountID): an ABARoutingNumber sends a fedwire wire (US/USD), a FinancialInstitutionNumber + BranchTransitNumber pair sends a lynx wire (Canada/CAD) and a BicSwift sends a swift wire (international). Supply the identifiers for one rail only; when a stored bank account carries identifiers for more than one, the beneficiary Country decides. lynx and swift are reserved and currently return a "not yet available" error. The detected rail is returned as WireType. Either CompanyName OR FirstName and LastName must be provided.

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

post/wire/withdraw

Request

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

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

Beneficiary's country as an ISO 3166-1 alpha-2 code. Must be US for a fedwire wire and CA for a lynx wire; any country for swift.

ZipCodestring required

Customer's zip code.

IPAddressstring

Customer's IP address.

ABARoutingNumberinteger

ABA routing transit number for the beneficiary's US bank account. Supplying it sends a fedwire wire.

AccountNumberinteger required

Account number for the customer's US bank account

Amountnumber required

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

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.

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

FinancialInstitutionNumberstring

Beneficiary bank's Canadian institution number. Supplying it with BranchTransitNumber sends a lynx wire.

BranchTransitNumberstring

Beneficiary bank's Canadian branch transit number. Supplying it with FinancialInstitutionNumber sends a lynx wire.

BicSwiftstring

Beneficiary bank's BIC/SWIFT code. Supplying it sends a swift wire.

IBANstring

Beneficiary IBAN, for swift wires. Either IBAN or AccountNumber must accompany BicSwift.

Currencystring

Settlement currency. Required for swift wires; implied by the rail otherwise (fedwire = USD, lynx = CAD) and rejected if it conflicts.

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.

WireType'fedwire' | 'lynx' | 'swift' required

The wire rail the transaction was created on, echoed from the request.

Noticestring

Present if the account has insufficient funds at the time of the transaction

Example response

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

Changes

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