Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Vopay Instant Endpoints

rtr/withdraw

This endpoint is used to instantly send funds out of your VoPay account and deposit them to the specified recipient's bank account.

Either an iq11 Token or FinancialInstitutionNumber/BranchTransitNumber/AccountNumber is required.

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

post/rtr/withdraw

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

The unique ID of the transaction that was just performed. This ID should be saved as it is required in order to look up status information on the transaction.

TransactionStatusstring required

The current transaction status. Statuses are: pending, in progress, successful, failed, cancelled

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,
  "TransactionStatus": "pending",
  "Flagged": "The transaction has been flagged as a potential duplicate."
}