v1

latestOpenAPI 3.1.02026-07-26457177.8 KB

Routines

Update an Existing Routine

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

This endpoint updates an existing Routine for a User.

🚧

Routine types may not be changed. Any of the non-required parameters below may be updated with this endpoint, provided they are included in the model for that Routine type.

put/v1/routines/{id}

Path parameters

idstring required

The unique ID of Routine

Request body

namestring

The name given for the Routine

payment_type'ach' | 'debit' | 'ledger'

The type of Payment

activeboolean

Whether the routine is active (True) or paused (False). Defaults to True.

source_idstring

The ID of the Source Account

destination_idstring

The ID of the Destination Account

amountnumber float

The amount of the transfer (when explicitly defined like one-time or recurring)

start_datestring date-time

The date the Routine should start processing (timezone is "America/Los_Angeles")

preferred_settlement_speed'T+1' | 'T+2' | 'T+4'

The requested settlement speed for resulting transfers

frequency'weekly' | 'bi-weekly' | 'monthly'

The frequency a repeating Routine should process

client_correlation_idstring

An optional correlation id that will be added to ACH Addenda. This will also be included in the Transfer response.

Response

Successful response

idstring

The unique ID of the Routine

type'one-time' | 'recurring'

The type of Routine