API References

Supported Operations

POST /api/v2/fedwire/fund

Debits funds from a customer's US bank account into your VoPay account via Fedwire.

Parameter	Type	Required	Description
Amount	decimal	Yes	Transaction amount in USD
Country	string	Yes	Must be `US`
ABARoutingNumber	string	Yes	9-digit ABA routing number
AccountNumber	string	Yes	Customer's bank account number
FirstName	string	Optional	Customer's first name
LastName	string	Optional	Customer's last name
CompanyName	string	Optional	Customer's company name
EmailAddress	string	Optional	Customer's email address
PhoneNumber	string	Optional	Customer's phone number
Address1	string	Optional	Customer's street address
Address2	string	Optional	Address line 2
City	string	Optional	Customer's city
State	string	Optional	Two-letter US state code
ZipCode	string	Optional	Customer's ZIP code
IPAddress	string	Optional	Customer's IP address
ClientAccountID	string	Optional	Link transaction to a sub-account
ContactID	string	Optional	Link transaction to a contact
ClientReferenceNumber	string	Optional	Your internal reference number
TransactionTypeCode	string	Optional	Transaction type code
GLCode	string	Optional	General ledger code
Notes	string	Optional	Internal notes
IdempotencyKey	string	Optional	Unique key to prevent duplicate transactions

POST /api/v2/fedwire/withdraw

Sends funds from your VoPay account to a customer's US bank account via Fedwire.

Parameter	Type	Required	Description
Amount	decimal	Yes	Transaction amount in USD
Country	string	Yes	Must be `US`
ABARoutingNumber	string	Yes	9-digit ABA routing number
AccountNumber	string	Yes	Recipient's bank account number
FirstName	string	Optional	Recipient's first name
LastName	string	Optional	Recipient's last name
CompanyName	string	Optional	Recipient's company name
EmailAddress	string	Optional	Recipient's email address
PhoneNumber	string	Optional	Recipient's phone number
Address1	string	Optional	Recipient's street address
Address2	string	Optional	Address line 2
City	string	Optional	Recipient's city
State	string	Optional	Two-letter US state code
ZipCode	string	Optional	Recipient's ZIP code
IPAddress	string	Optional	Recipient's IP address
ClientAccountID	string	Optional	Link transaction to a sub-account
ContactID	string	Optional	Link transaction to a contact
ClientReferenceNumber	string	Optional	Your internal reference number
TransactionTypeCode	string	Optional	Transaction type code
GLCode	string	Optional	General ledger code
Notes	string	Optional	Internal notes
IdempotencyKey	string	Optional	Unique key to prevent duplicate transactions
ParentTransactionID	string	Optional	ID of a parent transaction to link this to

GET /api/v2/fedwire/fund/transaction

Returns details of a single Fedwire fund transaction.

Parameter	Type	Required	Description
TransactionID	string	Yes	The transaction ID returned from `/fedwire/fund`

GET /api/v2/fedwire/withdraw/transaction

Returns details of a single Fedwire withdraw transaction.

Parameter	Type	Required	Description
TransactionID	string	Yes	The transaction ID returned from `/fedwire/withdraw`