---
title: "eft/fund/transaction"
method: GET
path: "/eft/fund/transaction"
tags: ["EFT Endpoint"]
---

# eft/fund/transaction

`GET /eft/fund/transaction`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/eft/fund/transaction`
- Auth: none declared

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.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `TransactionID` integer, required

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `TransactionID` integer, required: The unique ID of the transaction
  - `TransactionStatus` string, required: A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled
  - `TransactionDateTime` string, date-time, required: The timestamp when the transaction was created
  - `Amount` number, required: The dollar amount of the fund transaction. This is the amount that was withdrawn from the customer's bank account.
  - `Currency` string, required: The currency for the transaction.
  - `HoldAmount` number, required: Indicates if any of the funds that were credited to your account are still being held.
  - `LastModified` string, 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
  - `Address1` string, required: Customer's address line 1
  - `Address2` string, required: Customer's address line 2
  - `City` string, required: Customer's city
  - `Province/State` string, required: Customer's province specified using two character abbreviation (eg. BC, AB)
  - `Country` string, required: Customer's Country specified using full country name or ISO 3166-1 alpha-2 code
  - `PostalCode/Zipcode` string, required: Customer's postal code.
  - `FinancialInstitutionNumber` string, required: Three digit institution number for a Canadian bank.
  - `BranchTransitNumber` string, required: Transit number for the customer's account.
  - `AccountNumber` string, required: Customer's bank account number that funds were debited from.
  - `ClientReferenceNumber` string, required: An optional reference number which was associated with the transaction.
  - `ScheduledTransactionID` integer, required: Id of the scheduled transaction. This field only will be displayed if the scheduled transaction exists.
  - `TransactionTypeCode` string, required: CPA transaction code.
  - `SubTransactions` object: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of sub-transactions related to the main transaction. Includes every child transaction linked to this funding transaction on any payment rail, not only those settling on the funding transaction's own rail.
    - `0` object
      - `TransactionID` integer, required: Unique ID for the Transaction
      - `TransactionStatus` string, required: A message indicating the current transaction status. Statuses are: pending, in progress, successful, failed, cancelled, waiting on required transaction
      - `TransactionType` string, required: The internal transaction type identifier, as stored. This is a stable key for string comparison and is never renamed; use TransactionTypeLabel for display.
      - `TransactionTypeLabel` string, required: The customer-facing label for TransactionType. Types with no registered label are returned unchanged.
      - `TransactionAmount` number, required: The dollar amount of the sub-transaction, taken from whichever side of the ledger it carries: debit-side children report the amount debited, credit-side children (such as an account-transfer credit leg) the amount credited
      - `FailureReason` string, required: The reason the sub-transaction failed. Empty string when the transaction has not failed.
      - `Timestamp` string, date-time, required: The timestamp when the transaction status was last modified
  - `HoldReleaseDateTime` string, date-time, required: This timestamp indicates when the 'HoldAmount' funds will be released in EST.
  - `PayLinkDetails` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of TransactionInfo data
    - `0` object
      - `FirstName` string, required: Customer's first name
      - `LastName` string, required: Customer's last name
      - `EmailAddress` string, required: Recipient's email address.
      - `InvoiceNumber` string, required: Invoice number
      - `Note` string, required: If applicable, notes giving context to the transaction.
      - `SenderName` string, required: Sender's full name.
      - `PayLinkStatus` string, required: Status of the Paylink request
      - `FailureReason` string, required: Detailed description of why the paylink request failed.
      - `PayLinkCreated` string, date, required
  - `GLCode` string, required: General ledger code.

---

[API](https://skmtc.dev/vopay/apis/payment-rails.md) - [All operations](https://skmtc.dev/vopay/apis/payment-rails/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-rails/revisions/d6fe8969ddcf?raw)