Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Vopay Instant Endpoints

rtr/withdraw/transaction

This endpoint is used to look up details on a single VoPay Instant withdraw transaction. Withdraw transactions debit funds from your account and deposit them into the customer's account.

get/rtr/withdraw/transaction

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDinteger

Unique ID of the withdraw transaction. Must provide either a TransactionID or ClientReferenceNumber.

ClientReferenceNumberstring

A reference number to use to search the transaction. Must provide either a TransactionID or ClientReferenceNumber.

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

TransactionStatusstring required

A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled

TransactionDateTimestring date-time required

The timestamp when the transaction was created

Amountnumber required

The dollar amount of the withdraw transaction. This is the amount to be deposited into the recipient's bank account.

Currencystring required

The currency for the transaction.

RecipientNamestring required

Recipient's name

FinancialInstitutionNumberstring required

Three digit institution number for a Canadian bank.

BranchTransitNumberstring required

Transit number for the customer's account.

AccountNumberstring required

Recipient's bank account number that funds were deposited to.

ClientReferenceNumberstring required

An optional reference number which was associated with the transaction.

ProcessingDatestring date-time required

This timestamp indicates when the transaction record was processed..

GLCodestring required

General ledger code.

LastModifiedstring date-time required

This timestamp indicates when the transaction record was last modified.

TransactionTypeCodestring required

CPA transaction code.

Example response

{
  "Success": true,
  "TransactionStatus": "pending",
  "TransactionDateTime": "2019-11-01 12:00:00",
  "Currency": "CAD",
  "RecipientName": "VoPay",
  "FinancialInstitutionNumber": "112",
  "BranchTransitNumber": "11809",
  "AccountNumber": "227654387",
  "ProcessingDate": "2019-11-03 01:00:00",
  "GLCode": "4300",
  "LastModified": "2019-11-03 01:00:00",
  "TransactionTypeCode": "999"
}