VOvopay
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

Request

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

Recipient's first name

LastNamestring required

Recipient's last name

CompanyNamestring

Company's name

AccountNumberstring required

Recipient's bank account number. This is the account that funds will be deposited into.

FinancialInstitutionNumberstring required

Canadian banks. Three digit institution number.

BranchTransitNumberstring required

Canadian banks. Transit number for the Recipient's account.

Tokenstring

Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.

Amountnumber required

The amount in the specified currency to deposit into the recipient's bank account.

ClientReferenceNumberstring

An optional reference number to associate with the transaction.

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

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."
}

Changes

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