Routines

Overview

Routines are the instructions to move money, while Transfers are the actual vehicle that move the money. Routines are the parent object of Transfers. A Transfer is a child object of the Routine. A Transfer cannot exist without a Routine. There are one-time Routines and recurring Routines. There are various kinds of recurring routines, some with fixed amounts and others with variable amounts. A Routine can have multiple Transfers, but a Transfer cannot have multiple Routines.

Types of Routines

One Time

Move money between two authorized accounts on a specific date.

Request Body:

[
  {
    "type": "one-time",
    "name": "My One Time Transfer",
    "source_id": "your_source_id",
    "destination_id": "your_destination_id",
    "amount": 20,
    "start_date": "2020-10-29"
  }
]

In Practice:

A User can select a One Time Transfer, specifying the amount that they would like to transfer and where the Transfer should be deposited. The Routine will run once created, checking the balance of the Source Account before initiating the Transfer to ensure that no accounts are overdrawn.

Routine Specific Parameters Required:

Recurring

Move a specified amount of money from one authorized Account to another authorized Account on a recurring basis starting on a specific date.

Request Body:

[
  {
    "type": "recurring",
    "name": "My Recurring Routine",
    "source_id": "your_source_id",
    "destination_id": "your_destination_id",
    "amount": 20,
    "start_date": "2020-10-29",
    "frequency": "monthly"
  }
]

In Practice:

When a User creates a Recurring Transfer, they must define the amount that they want to transfer and then the frequency the Routine should run. Once created, the Routine will run at the prescribed interval, checking the balance of the Source Account before initiating the Transfer to ensure that no accounts are overdrawn.

Like all Routines, it can be Paused (or Activated again). When Paused, it will not create a new Transfer even when the time interval is triggered. It can be Deleted as well, where it will no longer run again and will be removed from the active Routines list.

Routine Specific Parameters Required:

Peer-to-Peer

Move money between two authorized accounts, from one authorized User to another.

Request Body:

[
  {
    "type": "one-time",
    "name": "My P2P Transfer",
    "source_id": "your_source_id",
    "destination_id": "your_destination_id",
    "destination_user_id": "your_id_for_the_receiving_user",
    "amount": 20,
    "start_date": "2020-10-29"
  }
]

In Practice:

Transferring funds between two different Users is almost exactly like a One Time Transfer Routine; however, the request body includes an additional parameter that defines the User that will receive the funds. The parameters that differentiate the Sending User and Receiving User are as follows:

Sending User:

• access_token from the authorization header defines the authorization for the User sending funds
• source_id indicates the source of funds, and must be one of the Sending User's Accounts

Receiving User:

• destination_user_id is the user_id for the Receiving User, which must have an active access_token
• destination_id indicates the destination of funds, and must be one of the Receiving User's Accounts

Routine Specific Parameters Required:

Appendix

Routine Frequency