v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Client Account Transfer Endpoints

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.

get/account/client-accounts/scheduled-transfers

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ScheduledTransferIDinteger

ID of the schedule transfer (if this value is present, we list the details of the scheduled tranfser)

ClientAccountIDstring int32

The Client Account ID that the scheduled transactions belong to

StartDatestring date-time

Return Client account transfers scheduled for or after this date/time. Can be specified in YYYY-MM-DD format.

EndDatestring date-time

Return Client account transfers scheduled for or before this date/time. Can be specified in YYYY-MM-DD format.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "ScheduledClientAccountTransfers": {
    "0": {
      "DebitorClientAccountID": "JohnSmith",
      "RecipientClientAccountID": "AvaLovelace",
      "RecipientClientAccountIDSplit": "[{\"ClientAccountID\":\"client_account_id_1\",\"Amount\":\"2\"},{\"ClientAccountID\":\"client_account_id_2\",\"Amount\":\"2\"}]",
      "TransferType": "fund-transfer",
      "Frequency": "weekly",
      "SemiMonthlyFrequencyType": "SemiMonthFirstAndFifteenth",
      "ClientReferenceNumber": "ABC123",
      "Notes": "This is a note",
      "TransactionLabel": "ACME Corp",
      "Description": "Scheduled transfer 1234",
      "ScheduleStartDate": "2020-01-01",
      "ScheduleEndDate": "2021-01-01",
      "Status": "in progress",
      "DateAdded": "2023-11-03 01:00:00",
      "UpcomingTransfers": {
        "0": {
          "ScheduledTransferID": "40",
          "TransferDate": "2020-01-01",
          "Status": "upcoming"
        }
      },
      "CompletedTransfers": {
        "0": {
          "ScheduledTransferID": "39",
          "TransferDate": "2020-01-01",
          "Status": "completed",
          "FailureReason": "DebitorClientAccountID does not exist"
        }
      }
    }
  }
}