API Reference

Supported Operations

POST /api/v2/rtr/withdraw

Sends funds from your VoPay account to a customer's bank account via the Real-Time Rail.

Parameter	Type	Required	Description
Amount	decimal	Yes	Transaction amount in CAD
FinancialInstitutionNumber	string	Conditional	3-digit bank institution number. Required if not using a token
BranchTransitNumber	string	Conditional	5-digit branch transit number. Required if not using a token
AccountNumber	string	Conditional	Customer's bank account number. Required if not using a token
Token	string	Conditional	Tokenized bank account. Use instead of raw banking details
FirstName	string	Optional	Customer's first name
LastName	string	Optional	Customer's last name
CompanyName	string	Optional	Customer's company name
IsCompany	boolean	Optional	Set to true if the recipient is a business
ClientAccountID	string	Optional	Link transaction to a sub-account
ContactID	string	Optional	Link transaction to a contact
WalletID	string	Optional	Source wallet ID
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

POST /api/v2/rtr/withdraw/transaction

Returns details of a single RTR withdraw transaction.

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

POST /api/v2/rtr/withdraw/transaction/request-cancellation

Submits a cancellation request for an RTR withdraw transaction. Cancellation is not guaranteed as the transaction may have already settled.

Parameter	Type	Required	Description
TransactionID	string	Yes	The transaction ID to request cancellation for