v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

EFT Endpoint

eft/withdraw/transaction

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

get/eft/withdraw/transaction

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDinteger required

Unique ID of the withdraw transaction

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.

HoldAmountnumber required

Will always be 0 for withdraw transactions, however parameter is included to keep return data format consistent with the format used for fund transactions.

LastModifiedstring date-time required

This timestamp indicates when the transaction record was last modified. In normal circumstances withdraw transaction record will not be modified.

CompanyName*string required

Company's name

FirstName*string required

Recipient's first name

LastNamestring required

Recipient's last name

Address1string required

Recipient's address line 1

Address2string required

Recipient's address line 2

Citystring required

Recipient's city

Provincestring required

Recipient's province specified using two character abbreviation (eg. BC, AB)

Countrystring required

Recipient's country specified using full country name.

PostalCodestring required

Recipient's postal code.

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.

TransactionTypeCodestring required

CPA transaction code.

GLCodestring required

General ledger code.

Example response

{
  "Success": true,
  "TransactionStatus": "pending",
  "TransactionDateTime": "2019-11-01 12:00:00",
  "Currency": "CAD",
  "LastModified": "2019-11-03 01:00:00",
  "CompanyName*": "VoPay",
  "FirstName*": "John",
  "LastName": "Doe",
  "Address1": "112 Bentall Street",
  "City": "Vancouver",
  "Province": "BC",
  "Country": "Canada",
  "PostalCode": "V2W 4V6",
  "FinancialInstitutionNumber": "112",
  "BranchTransitNumber": "11809",
  "AccountNumber": "227654387",
  "TransactionTypeCode": "999",
  "PayLinkDetails": {
    "0": {
      "FirstName": "John",
      "LastName": "Doe",
      "EmailAddress": "john.doe@vopay.com",
      "InvoiceNumber": "ABC1234",
      "Note": "Paylink requested to the client 123",
      "SenderName": "John Doe",
      "PayLinkStatus": "pending",
      "PayLinkCreated": "2019-11-03 01:00:00"
    }
  },
  "GLCode": "4300"
}