---
updatedAt: 2026-04-23T04:17:15.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# eft/scheduled-transactions

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

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Payment Rails",
    "description": "The Payment Rails API allows you to manage transactions in your account. You can cancel transactions, refund transactions, and confirm flagged transactions.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/eft/scheduled-transactions": {
      "get": {
        "description": "This endpoint is used to look up the list of all scheduled transactions, or you can list the details of a single scheduled transaction. \n\n If the value ScheduledTransactionID is present, we only list the details of that scheduled transaction.  \n\n * Either the response will be Company name or First name and Last name",
        "summary": "eft/scheduled-transactions",
        "tags": [
          "EFT Endpoint"
        ],
        "operationId": "EftScheduledTransactionGet",
        "deprecated": false,
        "parameters": [
          {
            "name": "AccountID",
            "in": "query",
            "required": true,
            "description": "Your account ID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Key",
            "in": "query",
            "required": true,
            "description": "API key for the account",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Signature",
            "in": "query",
            "required": true,
            "description": "Hashed signature for the request",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ClientAccountID",
            "in": "query",
            "required": false,
            "description": "Client Account ID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ScheduledTransactionID",
            "in": "query",
            "required": true,
            "description": "ID of the schedule Transaction (If this value is present, we list the details of the scheduled transactions)",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Limit ",
            "in": "query",
            "required": false,
            "description": "Limit the number of records that are returned.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "Offset ",
            "in": "query",
            "required": false,
            "description": "Use this parameter to set the starting point in the dataset.",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Success": {
                      "type": "boolean",
                      "description": "True if the request was successful, false if it failed",
                      "example": true
                    },
                    "ErrorMessage": {
                      "type": "string",
                      "description": "Contains a description of the error if the request failed",
                      "example": ""
                    },
                    "NumberOfRecords": {
                      "type": "number",
                      "description": "Total number of the scheduled transaction records returned",
                      "example": "1"
                    },
                    "ScheduledTransactions": {
                      "type": "object",
                      "description": "Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of scheduled Transaction info data",
                      "properties": {
                        "0": {
                          "type": "object",
                          "properties": {
                            "ID": {
                              "type": "integer",
                              "description": "Unique ID for the scheduled transaction",
                              "example": "15"
                            },
                            "Type": {
                              "type": "string",
                              "description": "The payment type of scheduled transaction; i.e., funding or withdraw",
                              "example": "funding"
                            },
                            "Amount": {
                              "type": "number",
                              "description": "The amount of the scheduled transaction",
                              "example": "25.00"
                            },
                            "Frequency": {
                              "type": "string",
                              "description": "The frequency of the schedule: single or recurring",
                              "example": "recurring"
                            },
                            "Description": {
                              "type": "string",
                              "description": "Description of the scheduled transaction",
                              "example": "Scheduled transaction 1234"
                            },
                            "Notes": {
                              "type": "string",
                              "description": "Note that will be attached to each scheduled transaction",
                              "example": "Loan repayment 1234"
                            },
                            "NameOfFrequency": {
                              "type": "string",
                              "description": "Name of the frequency of the transaction: weekly, biweekly, monthly, bimonthly, 3 months, 6 months, yearly. Only provided if Frequency provided is recurring.",
                              "example": "weekly"
                            },
                            "Status": {
                              "type": "string",
                              "description": "A message indicating the current transaction status. Statuses are: cancelled, completed, or in progress",
                              "example": "in progress"
                            },
                            "StartDate": {
                              "type": "string",
                              "format": "date",
                              "description": "Date from which the transaction will be started",
                              "example": "2020-01-01"
                            },
                            "EndDate": {
                              "type": "string",
                              "format": "date",
                              "description": "Date from which the transaction will end",
                              "example": "2021-01-01"
                            },
                            "EndingAfterPayments": {
                              "type": "integer",
                              "description": "Number of payments after which the transaction processing will end",
                              "example": "12"
                            },
                            "ScheduledDetails": {
                              "type": "object",
                              "description": "Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Extra details of the scheduled transaction",
                              "properties": {
                                "0": {
                                  "type": "object",
                                  "properties": {
                                    "FlinksAccountID": {
                                      "type": "string",
                                      "description": "Used by clients with a Flinks account",
                                      "example": "ACBDF-GAFSHD-AHBS-123456"
                                    },
                                    "FlinksLoginID": {
                                      "type": "string",
                                      "description": "Used by clients with a Flinks account",
                                      "example": "ACBDF-GAFSHD-AHBS-123456"
                                    },
                                    "Token": {
                                      "type": "string",
                                      "description": "Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints",
                                      "example": "ACBDF-GAFSHD-AHBS-123456"
                                    },
                                    "PlaidAccessToken": {
                                      "type": "string",
                                      "description": "Used by clients with a Plaid account",
                                      "example": "ACBDF-GAFSHD-AHBS-123456"
                                    },
                                    "PlaidAccountID": {
                                      "type": "string",
                                      "description": "Used by clients with a Plaid account",
                                      "example": "ACBDF-GAFSHD-AHBS-123456"
                                    },
                                    "PlaidPublicToken": {
                                      "type": "string",
                                      "description": "Used by clients with a Plaid account",
                                      "example": "ACBDF-GAFSHD-AHBS-123456"
                                    },
                                    "PlaidProcessorToken": {
                                      "type": "string",
                                      "description": "Used by clients with a Plaid account. If you use this field PlaidPublicToken, PlaidAccessToken, and PlaidAccountID are not neccesary",
                                      "example": "ACBDF-GAFSHD-AHBS-123456"
                                    },
                                    "AccountNumber": {
                                      "type": "string",
                                      "description": "Recipient's bank account number that funds were deposited to.",
                                      "example": "*****387"
                                    },
                                    "FinancialInstitutionNumber": {
                                      "type": "string",
                                      "description": "Three digit institution number for a Canadian bank.",
                                      "example": "112"
                                    },
                                    "BranchTransitNumber": {
                                      "type": "string",
                                      "description": "Transit number for the customer's account.",
                                      "example": "**809"
                                    },
                                    "CompanyName*": {
                                      "type": "string",
                                      "description": "Company's name",
                                      "example": "VoPay"
                                    },
                                    "FirstName*": {
                                      "type": "string",
                                      "description": "Customer's first name",
                                      "example": "John"
                                    },
                                    "LastName*": {
                                      "type": "string",
                                      "description": "Customer's last name",
                                      "example": "Doe"
                                    },
                                    "Address1": {
                                      "type": "string",
                                      "description": "Recipient's address line 1",
                                      "example": "112 Bentall Street"
                                    },
                                    "City": {
                                      "type": "string",
                                      "description": "Recipient's city",
                                      "example": "Vancouver"
                                    },
                                    "PostalCode": {
                                      "type": "string",
                                      "description": "Recipient's postal code.",
                                      "example": "V2W 4V6"
                                    },
                                    "Province": {
                                      "type": "string",
                                      "description": "Recipient's province specified using two character abbreviation (eg. BC, AB)",
                                      "example": "BC"
                                    },
                                    "Country": {
                                      "type": "string",
                                      "description": "Recipient's country specified using full country name.",
                                      "example": "Canada"
                                    },
                                    "ClientReferenceNumber": {
                                      "type": "string",
                                      "description": "An optional reference number which was associated with the transaction.",
                                      "example": ""
                                    },
                                    "ErrorMessage": {
                                      "type": "object",
                                      "description": "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",
                                      "properties": {
                                        "0": {
                                          "type": "object",
                                          "properties": {
                                            "Success": {
                                              "type": "boolean",
                                              "description": "True if the request was successful, false if it failed",
                                              "example": false
                                            },
                                            "ErrorMessage": {
                                              "type": "string",
                                              "description": "Contains a description of the error if the request failed",
                                              "example": ""
                                            }
                                          },
                                          "required": [
                                            "Success",
                                            "ErrorMessage"
                                          ]
                                        }
                                      },
                                      "x-list-of": "inline",
                                      "x-empty-when": "no items"
                                    }
                                  },
                                  "required": [
                                    "FlinksAccountID",
                                    "FlinksLoginID",
                                    "Token",
                                    "PlaidAccessToken",
                                    "PlaidAccountID",
                                    "PlaidPublicToken",
                                    "PlaidProcessorToken",
                                    "AccountNumber",
                                    "FinancialInstitutionNumber",
                                    "BranchTransitNumber",
                                    "CompanyName*",
                                    "FirstName*",
                                    "LastName*",
                                    "Address1",
                                    "City",
                                    "PostalCode",
                                    "Province",
                                    "Country",
                                    "ClientReferenceNumber",
                                    "ErrorMessage"
                                  ]
                                }
                              },
                              "x-list-of": "inline",
                              "x-empty-when": "no items"
                            },
                            "UpcomingTransactions": {
                              "type": "object",
                              "description": "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)",
                              "properties": {
                                "0": {
                                  "type": "object",
                                  "properties": {
                                    "TransactionID": {
                                      "type": "integer",
                                      "description": "ID of the eft transaction (Empty because it is a future payment)",
                                      "example": ""
                                    },
                                    "ScheduledDate": {
                                      "type": "string",
                                      "format": "date",
                                      "description": "Date from which the payment will start",
                                      "example": "2020-01-01"
                                    },
                                    "ProcessingDate": {
                                      "type": "string",
                                      "format": "date",
                                      "description": "Date where this payment was processed (Empty because it is a future payment)",
                                      "example": ""
                                    },
                                    "LastModified": {
                                      "type": "string",
                                      "format": "date",
                                      "description": "Date of the last modification of this payment (Empty because it is a future payment)",
                                      "example": ""
                                    },
                                    "Status": {
                                      "type": "string",
                                      "description": "Status of the upcoming payment (Empty because it is a future payment)",
                                      "example": ""
                                    },
                                    "Amount": {
                                      "type": "number",
                                      "description": "The amount of the scheduled transaction",
                                      "example": "10.00"
                                    }
                                  },
                                  "required": [
                                    "TransactionID",
                                    "ScheduledDate",
                                    "ProcessingDate",
                                    "LastModified",
                                    "Status",
                                    "Amount"
                                  ]
                                }
                              },
                              "x-list-of": "inline",
                              "x-empty-when": "no items"
                            },
                            "CompletedTransactions": {
                              "type": "object",
                              "description": "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)",
                              "properties": {
                                "0": {
                                  "type": "object",
                                  "properties": {
                                    "TransactionID": {
                                      "type": "integer",
                                      "description": "ID of the EFT transaction",
                                      "example": "1"
                                    },
                                    "ScheduledDate": {
                                      "type": "string",
                                      "format": "date",
                                      "description": "Date from which the transaction will start",
                                      "example": "2020-01-01"
                                    },
                                    "ProcessingDate": {
                                      "type": "string",
                                      "format": "date",
                                      "description": "Date where this transaction was processed",
                                      "example": "2020-01-02"
                                    },
                                    "LastModified": {
                                      "type": "string",
                                      "format": "date",
                                      "description": "Date of the last modification of this transaction",
                                      "example": "2020-01-02"
                                    },
                                    "Status": {
                                      "type": "string",
                                      "description": "Status of the transaction",
                                      "example": "pending"
                                    },
                                    "Amount": {
                                      "type": "number",
                                      "description": "The amount of the transaction",
                                      "example": "10.00"
                                    }
                                  },
                                  "required": [
                                    "TransactionID",
                                    "ScheduledDate",
                                    "ProcessingDate",
                                    "LastModified",
                                    "Status",
                                    "Amount"
                                  ]
                                }
                              },
                              "x-list-of": "inline",
                              "x-empty-when": "no items"
                            }
                          },
                          "required": [
                            "ID",
                            "Type",
                            "Amount",
                            "Frequency",
                            "Description",
                            "Notes",
                            "NameOfFrequency",
                            "Status",
                            "StartDate",
                            "EndDate",
                            "EndingAfterPayments",
                            "ScheduledDetails",
                            "UpcomingTransactions",
                            "CompletedTransactions"
                          ]
                        }
                      },
                      "x-empty-when": "no scheduled transactions match",
                      "x-list-of": "inline"
                    },
                    "Pagination": {
                      "type": "object",
                      "description": "Pagination metadata",
                      "properties": {
                        "TotalRecords": {
                          "type": "string",
                          "description": "Total number of transaction records in that search range.",
                          "example": "1000"
                        },
                        "Offset": {
                          "type": "string",
                          "description": "Use this parameter to set the starting point in the dataset.",
                          "example": "1000"
                        },
                        "Limit": {
                          "type": "string",
                          "description": "Limit the number of records that are returned.",
                          "example": "1000"
                        }
                      },
                      "x-absent-when": "no pagination metadata available",
                      "required": [
                        "TotalRecords",
                        "Offset",
                        "Limit"
                      ]
                    }
                  },
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "NumberOfRecords",
                    "ScheduledTransactions"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```