---
title: "eft/scheduled-transactions"
method: GET
path: "/eft/scheduled-transactions"
tags: ["EFT Endpoint"]
---

# eft/scheduled-transactions

`GET /eft/scheduled-transactions`

## Request

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

This endpoint is used to look up the list of all scheduled transactions, or you can list the details of a single scheduled transaction. 

 If the value ScheduledTransactionID is present, we only list the details of that scheduled transaction.  

 * Either the response will be Company name or First name and Last name

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ClientAccountID` string
- `ScheduledTransactionID` integer, required
- `Limit ` integer
- `Offset ` integer

## 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
  - `NumberOfRecords` number, required: Total number of the scheduled transaction records returned
  - `ScheduledTransactions` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of scheduled Transaction info data
    - `0` object
      - `ID` integer, required: Unique ID for the scheduled transaction
      - `Type` string, required: The payment type of scheduled transaction; i.e., funding or withdraw
      - `Amount` number, required: The amount of the scheduled transaction
      - `Frequency` string, required: The frequency of the schedule: single or recurring
      - `Description` string, required: Description of the scheduled transaction
      - `Notes` string, required: Note that will be attached to each scheduled transaction
      - `NameOfFrequency` string, required: Name of the frequency of the transaction: weekly, biweekly, monthly, bimonthly, 3 months, 6 months, yearly. Only provided if Frequency provided is recurring.
      - `Status` string, required: A message indicating the current transaction status. Statuses are: cancelled, completed, or in progress
      - `StartDate` string, date, required: Date from which the transaction will be started
      - `EndDate` string, date, required: Date from which the transaction will end
      - `EndingAfterPayments` integer, required: Number of payments after which the transaction processing will end
      - `ScheduledDetails` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Extra details of the scheduled transaction
        - `0` object
          - `FlinksAccountID` string, required: Used by clients with a Flinks account
          - `FlinksLoginID` string, required: Used by clients with a Flinks account
          - `Token` string, required: Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints
          - `PlaidAccessToken` string, required: Used by clients with a Plaid account
          - `PlaidAccountID` string, required: Used by clients with a Plaid account
          - `PlaidPublicToken` string, required: Used by clients with a Plaid account
          - `PlaidProcessorToken` string, required: Used by clients with a Plaid account. If you use this field PlaidPublicToken, PlaidAccessToken, and PlaidAccountID are not neccesary
          - `AccountNumber` string, required: Recipient's bank account number that funds were deposited to.
          - `FinancialInstitutionNumber` string, required: Three digit institution number for a Canadian bank.
          - `BranchTransitNumber` string, required: Transit number for the customer's account.
          - `CompanyName*` string, required: Company's name
          - `FirstName*` string, required: Customer's first name
          - `LastName*` string, required: Customer's last name
          - `Address1` string, required: Recipient's address line 1
          - `City` string, required: Recipient's city
          - `PostalCode` string, required: Recipient's postal code.
          - `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.
          - `ClientReferenceNumber` string, required: An optional reference number which was associated with the transaction.
          - `ErrorMessage` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Extra details of the scheduled transaction payments, this is the log of the failures
            - `0` object
              - …
      - `UpcomingTransactions` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Upcoming transaction listing (This option only will be available if the user provides ScheduledTransactionID as a parameter)
        - `0` object
          - `TransactionID` integer, required: ID of the eft transaction (Empty because it is a future payment)
          - `ScheduledDate` string, date, required: Date from which the payment will start
          - `ProcessingDate` string, date, required: Date where this payment was processed (Empty because it is a future payment)
          - `LastModified` string, date, required: Date of the last modification of this payment (Empty because it is a future payment)
          - `Status` string, required: Status of the upcoming payment (Empty because it is a future payment)
          - `Amount` number, required: The amount of the scheduled transaction
      - `CompletedTransactions` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... List of the completed transactions (This option only will be available if the user provides ScheduledTransactionID as a parameter)
        - `0` object
          - `TransactionID` integer, required: ID of the EFT transaction
          - `ScheduledDate` string, date, required: Date from which the transaction will start
          - `ProcessingDate` string, date, required: Date where this transaction was processed
          - `LastModified` string, date, required: Date of the last modification of this transaction
          - `Status` string, required: Status of the transaction
          - `Amount` number, required: The amount of the transaction
  - `Pagination` object: Pagination metadata
    - `TotalRecords` string, required: Total number of transaction records in that search range.
    - `Offset` string, required: Use this parameter to set the starting point in the dataset.
    - `Limit` string, required: Limit the number of records that are returned.

---

[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)