Sign in
Scheduled Transfers

Cancel a Scheduled Transfer

Cancels the scheduled transfer specified in the request URL. Note that the customer must already have authorized and confirmed scheduled transfer. Note: This call triggers the change request process.

patch/v1/accounts/{account_id}/scheduled_transfers/{id}/cancel

Path parameters

idstring required

The ID of the scheduled transfer to cancel.

account_idstring required

The account ID of the account that the scheduled transfer is associated with.

Request body

authorizer_idstring required

The ID of the person who should authorize the scheduled transfer.

Example request

{
  "authorizer_id": "cf67beb032b2abbfc444f1641fa679bccper"
}

Response

The request is accepted, and the customer must confirm the change request.

idstring

ID of the change request.

status'ACCEPTED' | 'AUTHORIZATION_REQUIRED' | 'CONFIRMATION_REQUIRED' | 'COMPLETED' | 'FAILED'

The current status of the change request.

updated_atstring date-time

UTC timestamp from the last time the change request was updated.

urlstring

URL to use to authorize the change request.

Example response

{
  "id": "d6c778822b2d7bd3b778935bcfd0d1d3csc",
  "status": "CONFIRMATION_REQUIRED",
  "updated_at": "2022-04-21T13:59:52+00:00",
  "url": "https://example.com/authorize"
}