---
title: "account/client-accounts/scheduled-transfers"
method: GET
path: "/account/client-accounts/scheduled-transfers"
tags: ["Client Account Transfer Endpoints"]
---

# account/client-accounts/scheduled-transfers

`GET /account/client-accounts/scheduled-transfers`

This endpoint is used to look up either the list of all scheduled client account transfers, or to list the details of a single scheduled client account transfer. 

 If the value ScheduledTransferID is present, we only list the details of that scheduled client account transfer.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ScheduledTransferID` integer
- `ClientAccountID` string, int32
- `StartDate` string, date-time
- `EndDate` string, date-time

## Response `200`

- object
  - `Success` boolean — True if the request was successful, false if it failed
  - `ErrorMessage` string — Contains a description of the error if the request failed
  - `ScheduledClientAccountTransfers` object — Collection of scheduled transfer info data
    - `0` object
      - `ID` integer — Unique ID for the scheduled transfer
      - `DebitorClientAccountID` string — The debitor ClientAccountID
      - `RecipientClientAccountID` string — The recipient ClientAccountID
      - `RecipientClientAccountIDSplit` string — The split details for the recipient client accounts
      - `Amount` number — The amount of the scheduled transaction
      - `TransferType` string — The payment type of scheduled transfer; i.e., fund-transfer, transfer-withdraw or fund-transfer-withdraw
      - `ReverseOnFailure` boolean — Instructions on whether or not the scheduled transfer should be reversed if it fails
      - `Frequency` string — The frequency of the schedule transfer: single, weekly, monthly, semi-monthly, annual
      - `SemiMonthlyFrequencyType` string — The semi-monthly frequency type, if applicable.
      - `ClientReferenceNumber` string — An optional reference number which was associated with the transfers.
      - `Notes` string — An optional note which was associated with the transfers.
      - `TransactionLabel` string — An optional transaction label which was associated with the transfers.
      - `Description` string — Description of the scheduled transfer
      - `ScheduleStartDate` string, date — Date from which the transfer(s) will be started
      - `ScheduleEndDate` string, date — Date from which the transfers will end
      - `EndingAfterPayments` integer — Number of payments after which the transfer processing will end
      - `Status` string — A message indicating the current transaction status. Statuses are: cancelled, completed, or in progress
      - `DateAdded` string, date — Date the schedule transfer was added
      - `UpcomingTransfers` object — Upcoming transfer listing (This option only will be available if the user provides ScheduledTransferID as a parameter)
        - `0` object
          - `ScheduledTransferID` string — Scheduled Transfer ID for upcoming transaction
          - `TransferDate` string, date — Date when the transfer will get created
          - `Amount` number — The amount of the scheduled transfer
          - `Status` string — Status of the scheduled transfer
          - `FailureReason` string — Failure reason of the scheduled transfer (empty for upcoming transactions)
          - `FundingTransactionID` integer — ID of the funding transaction (empty for upcoming transactions)
          - `AccountTransferID` integer — ID of the account transfer (empty for upcoming transactions)
          - `WithdrawTransactionID` integer — ID of the withdraw transaction (empty for upcoming transactions)
      - `CompletedTransfers` object — List of the completed transfers (This option only will be available if the user provides ScheduledTransferID as a parameter)
        - `0` object
          - `ScheduledTransferID` string — Scheduled Transfer ID for completed transaction
          - `TransferDate` string, date — Date when the transfer will get created
          - `Amount` number — The amount of the scheduled transfer
          - `Status` string — Status of the scheduled transfer
          - `FailureReason` string — Failure reason of the scheduled transfer, if applicable
          - `FundingTransactionID` integer — ID of the funding transaction, if applicable
          - `AccountTransferID` integer — ID of the account transfer, if applicable
          - `WithdrawTransactionID` integer — ID of the withdraw transaction, if applicable

---

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