v1

latestOpenAPI 3.1.02026-07-26457177.8 KB

Routines

Get a Specific Routine for a User

📘

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

This endpoint retrieves a specific Routine for a User based on the Routine ID.

get/v1/routines/{id}

idstring required

The unique ID of Routine

Successful response

idstring

The unique ID of the Routine

type'one-time' | 'recurring'

The type of Routine

namestring

The name given for the Routine

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

The type of payment

source_idstring

The ID of the Source Account

destination_idstring

The ID of the Destination Account

destination_user_idstring

The User ID associated with the Destination Account (if peer-to-peer)

ultimate_receiver_idstring

The User ID of the ultimate receiver of the Routine

ultimate_sender_idstring

The User ID of the ultimate sender of the Routine

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.

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

activeboolean

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

statusstring

The Routine's status on the platform (see Routine Statuses)

failure_reasonstring

The reason for the routine processing failure (property will not be returned if null)

createdstring date-time

The date the Routine was created