Sign in
Client Account Transfer Endpoints

account/client-accounts/transfer/schedule/cancel

This endpoint is used to cancel a scheduled client account transfer and all remaining payments belonging to that scheduled transfer. Only scheduled transfers with the status in progress can be cancelled.

post/account/client-accounts/transfer/schedule/cancel

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Statusstring

A message indicating the resulting scheduled transfer status.

Example response

{
  "Status": "cancelled"
}