API Reference

wire/withdraw

post
https://earthnode-dev.vopay.com/api/v2/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string

Client Account ID

string

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

string
required

Customer's first name

string
required

Customer's last name

string
required

Company's name

string
required

Customer's email address

string
required

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

string
required

Customer's address line 1

string

Customer's address line 2

string
required

Customer's city

string
required

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

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

string
required

Customer's zip code.

string

Customer's IP address.

integer

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

integer
required

Account number for the customer's US bank account

number
required

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

string

An optional note to associate with the transaction.

string

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

string

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.

string

An optional unique identification general ledger code.

string

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

string

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

string

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

string

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

string

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

string

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

Response

Updated about 17 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 17 hours ago

Did this page help you?