---
updatedAt: 2026-08-17T19:31:34.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# account/client-accounts/transfer-withdraw/schedule

This endpoint is used to schedule a transfer-withdraw between two client accounts.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Client Accounts",
    "description": "The Client Accounts API allows you to create, manage and retrieve information about client accounts.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/account/client-accounts/transfer-withdraw/schedule": {
      "post": {
        "description": "This endpoint is used to schedule a transfer-withdraw between two client accounts.",
        "summary": "account/client-accounts/transfer-withdraw/schedule",
        "tags": [
          "Client Account Transfer Endpoints"
        ],
        "operationId": "ClientAccountTransferWithdrawSchedulePOST",
        "deprecated": false,
        "requestBody": {
          "$ref": "#/components/requestBodies/ClientAccountTransferWithdrawSchedulePOST"
        },
        "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": ""
                    },
                    "ScheduledTransferID": {
                      "type": "integer",
                      "description": "The unique ID of the scheduled transfer that was just created. This ID should be saved as it is required order to look up the status information on the scheduled transfer.",
                      "example": "1122"
                    }
                  },
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "ScheduledTransferID"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ],
  "components": {
    "requestBodies": {
      "ClientAccountTransferWithdrawSchedulePOST": {
        "content": {
          "application/x-www-form-urlencoded": {
            "schema": {
              "type": "object",
              "properties": {
                "AccountID": {
                  "description": "Your account ID",
                  "type": "string"
                },
                "Key": {
                  "description": "API key for the account",
                  "type": "string"
                },
                "Signature": {
                  "description": "Hashed signature for the request",
                  "type": "string"
                },
                "DebitorClientAccountID": {
                  "description": "ID of the client account transferring the funds",
                  "type": "string"
                },
                "RecipientClientAccountID": {
                  "description": "ID of the client account receiving the funds",
                  "type": "string"
                },
                "RecipientClientAccountIDSplit": {
                  "description": "A JSON formatted string specifying the details for a split payment. This must fit to the following format where the amount identifier is either Amount or Percentage, [{\"ClientAccountID\":\"client_account_id_1\",\"Amount\": \"5\"},{\"ClientAccountID\":\"client_account_id_2\",\"Amount\": \"10\"}]",
                  "type": "string"
                },
                "Amount": {
                  "description": "The amount to debit from the customer's bank account.",
                  "type": "number"
                },
                "Currency": {
                  "description": "3 character currency code for the currency. If this is not specified the transaction will use the account's local currency.",
                  "type": "string"
                },
                "FundingRail": {
                  "description": "Specifies the rail to use for the funding transaction. If this is not specified eft will be used for Canadian accounts and ach for US accounts.",
                  "type": "string"
                },
                "WithdrawRail": {
                  "description": "Specifies the rail to use for the withdraw transaction. If this is not specified eft will be used for Canadian accounts and ach for US accounts.",
                  "type": "string"
                },
                "ReverseOnFailure": {
                  "description": "Setting this to true will reverse both the fund and transfer should either fail. This is set to false, by default.",
                  "type": "boolean"
                },
                "ClientReferenceNumber": {
                  "description": "An optional reference number to associate with the transfers",
                  "type": "string"
                },
                "Notes": {
                  "description": "An optional note to associate with the transfers.",
                  "type": "string"
                },
                "TransactionLabel": {
                  "description": "The TransactionLabel overrides the originator short name on statements",
                  "type": "string"
                },
                "Frequency": {
                  "description": "The frequency of the scheduled transfer. Valid options are: single, weekly, monthly, semi-monthly, and yearly.",
                  "type": "string"
                },
                "ScheduleStartDate": {
                  "description": "Date from which the schedule will be started",
                  "type": "string"
                },
                "ScheduleEndDate": {
                  "description": "Date when the transfer processing will end (Only for recurring frequencies), Either provide ScheduleEndDate or EndingAfterPayments",
                  "type": "string"
                },
                "EndingAfterPayments": {
                  "description": "Number of payments after which the transfer processing will end (Only for recurring frequencies), Either provide ScheduleEndDate or EndingAfterPayments",
                  "type": "integer"
                },
                "SemiMonthlyFrequencyType": {
                  "description": "Type of semi-monthly frequency. This field is only required when Frequency is set to semi-monthly. The possible values are: SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast",
                  "type": "integer"
                },
                "Description": {
                  "description": "Description of the schedule transfer",
                  "type": "string"
                },
                "GLCode": {
                  "description": "An optional unique identification general ledger code.",
                  "type": "string"
                }
              },
              "required": [
                "AccountID",
                "Key",
                "Signature",
                "DebitorClientAccountID",
                "RecipientClientAccountID",
                "RecipientClientAccountIDSplit",
                "Amount",
                "Frequency",
                "ScheduleStartDate",
                "ScheduleEndDate",
                "EndingAfterPayments"
              ]
            }
          }
        },
        "required": true
      }
    }
  }
}
```