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

# eft/withdraw/transaction

`GET /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.

## 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 withdraw transaction. This is the amount to be deposited into the recipient's bank account.
  - `Currency` string, required — The currency for the transaction.
  - `HoldAmount` number, 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.
  - `LastModified` string, 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
  - `LastName` string, required — Recipient's last name
  - `Address1` string, required — Recipient's address line 1
  - `Address2` string, required — Recipient's address line 2
  - `City` string, required — Recipient's city
  - `Province` string, required — Recipient's province specified using two character abbreviation (eg. BC, AB)
  - `Country` string, required — Recipient's country specified using full country name.
  - `PostalCode` string, required — Recipient'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 — Recipient's bank account number that funds were deposited to.
  - `ClientReferenceNumber` string, required — An optional reference number which was associated with the transaction.
  - `TransactionTypeCode` string, required — CPA transaction code.
  - `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.net/vopay/apis/accounts.md) · [All operations](https://skmtc.net/vopay/apis/accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vopay/accounts/revisions/7033bd231ec7/schema)
