v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

EFT Endpoint

eft/fund/transaction

This endpoint is used to look up and return the full details on a single fund transaction. Fund transactions take money out of the customer's bank account and deposit them into your account.

get/eft/fund/transaction

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDinteger required

The unique ID of the fund 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 fund transaction. This is the amount that was withdrawn from the customer's bank account.

Currencystring required

The currency for the transaction.

HoldAmountnumber required

Indicates if any of the funds that were credited to your account are still being held.

LastModifiedstring date-time required

This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the status of the transaction changes or the HoldAmount is changed.

CompanyName*string required

Company's name

FirstName*string required

Customer's first name

LastName*string required

Customer's last name

Address1string required

Customer's address line 1

Address2string required

Customer's address line 2

Citystring required

Customer's city

Province/Statestring required

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

Countrystring required

Customer's Country specified using full country name or ISO 3166-1 alpha-2 code

PostalCode/Zipcodestring required

Customer's postal code.

FinancialInstitutionNumberstring required

Three digit institution number for a Canadian bank.

BranchTransitNumberstring required

Transit number for the customer's account.

AccountNumberstring required

Customer's bank account number that funds were debited from.

ClientReferenceNumberstring required

An optional reference number which was associated with the transaction.

ScheduledTransactionIDinteger required

Id of the scheduled transaction. This field only will be displayed if the scheduled transaction exists.

TransactionTypeCodestring required

CPA transaction code.

HoldReleaseDateTimestring date-time required

This timestamp indicates when the 'HoldAmount' funds will be released in EST.

GLCodestring required

General ledger code.

Example response

{
  "Success": true,
  "TransactionStatus": "pending",
  "TransactionDateTime": "2019-11-01 12:00:00",
  "Currency": "CAD",
  "LastModified": "2019-11-02 01:00:21",
  "CompanyName*": "VoPay",
  "FirstName*": "John",
  "LastName*": "Doe",
  "Address1": "112 Bentall Street",
  "City": "Vancouver",
  "Province/State": "BC",
  "Country": "Canada",
  "PostalCode/Zipcode": "V4W 5Z7",
  "FinancialInstitutionNumber": "112",
  "BranchTransitNumber": "11456",
  "AccountNumber": "1100456342",
  "ClientReferenceNumber": "876432",
  "TransactionTypeCode": "999",
  "SubTransactions": {
    "0": {
      "TransactionStatus": "waiting on required transaction",
      "TransactionDateTime": "2019-11-01 12:00:00",
      "Currency": "CAD",
      "LastModified": "2019-11-02 01:00:21",
      "CompanyName*": "VoPay",
      "FirstName*": "John",
      "LastName*": "Doe",
      "Address1": "112 Bentall Street",
      "City": "Vancouver",
      "Province": "BC",
      "Country": "Canada",
      "PostalCode": "V4W 5Z7",
      "FinancialInstitutionNumber": "112",
      "BranchTransitNumber": "11456",
      "AccountNumber": "1100456342",
      "ClientReferenceNumber": "876432"
    }
  },
  "HoldReleaseDateTime": "2019-11-02 23:59:59",
  "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"
}