Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. API reference
  3. Money movement
  4. Scheduled transfers

List schedules

Describes a list of schedules associated with an account. Append the hydrate=accounts query parameter to include partial account details in the response.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.read scope.

GET
/accounts/{accountID}/schedules
cURL Go TypeScript PHP Python Java Ruby 
1
2
3

curl -X GET "https://api.moov.io/accounts/{accountID}/schedules" \
  -H "Authorization: Bearer {token}" \
  -H "x-moov-version: v2024.01.00" \

1
2
3
4
5

mc, _ := moov.NewClient()

var accountID string

mc.ListSchedule(ctx, accountID)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

import { SDK } from "openapi";

const sdk = new SDK({
  xMoovVersion: "v2024.01.00",
});

async function run() {
  const result = await sdk.scheduling.list({
    skip: 60,
    count: 20,
    accountID: "b69f6366-984e-40f9-82a0-65335a43431d",
  });

  console.log(result);
}

run();
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

declare(strict_types=1);

require 'vendor/autoload.php';

use OpenAPI\OpenAPI;
use OpenAPI\OpenAPI\Models\Operations;

$sdk = OpenAPI\SDK::builder()
    ->setXMoovVersion('v2024.01.00')
    ->build();

$request = new Operations\ListSchedulesRequest(
    skip: 60,
    count: 20,
    accountID: 'b69f6366-984e-40f9-82a0-65335a43431d',
);

$response = $sdk->scheduling->list(
    request: $request
);

if ($response->scheduleListResponses !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

from openapi import SDK


with SDK(
    x_moov_version="v2024.01.00",
) as sdk:

    res = sdk.scheduling.list(account_id="b69f6366-984e-40f9-82a0-65335a43431d", skip=60, count=20)

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

package hello.world;

import java.lang.Exception;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.operations.ListSchedulesResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        SDK sdk = SDK.builder()
                .xMoovVersion("v2024.01.00")
            .build();

        ListSchedulesResponse res = sdk.scheduling().list()
                .skip(60L)
                .count(20L)
                .accountID("b69f6366-984e-40f9-82a0-65335a43431d")
                .call();

        if (res.scheduleListResponses().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

require 'openapi'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::SDK.new(
      x_moov_version: 'v2024.01.00',
    )

req = Models::Operations::ListSchedulesRequest.new(
  skip: 60,
  count: 20,
  account_id: 'b69f6366-984e-40f9-82a0-65335a43431d',
)

res = s.scheduling.list(request: req)

unless res.schedule_list_responses.nil?
  # handle response
end
200 401 403 429 500 504
The request completed successfully.
application/json
Example
[
  {
    "sourceAccount": {
      "accountID": "string",
      "displayName": "string",
      "email": "string"
    },
    "destinationAccount": {
      "accountID": "string",
      "displayName": "string",
      "email": "string"
    },
    "partnerAccount": {
      "accountID": "string",
      "displayName": "string",
      "email": "string"
    },
    "description": "string",
    "destinationAccountID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
    "mode": "production",
    "occurrences": [
      {
        "scheduleID": "b7aa2ee2-8783-4fc9-9fa6-a4720b30b20d",
        "occurrenceID": "74fabb88-d79e-4e9e-b63b-2ddc96054e61",
        "mode": "production",
        "generated": true,
        "indefinite": true,
        "canceledOn": "2019-08-24T14:15:22Z",
        "runOn": "2019-08-24T14:15:22Z",
        "runTransfer": {
          "amount": {
            "currency": "USD",
            "value": 1204
          },
          "destination": {
            "paymentMethodID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
            "achDetails": {
              "companyEntryDescription": "Gym dues",
              "originatingCompanyName": "Whole Body Fit"
            },
            "cardDetails": {
              "dynamicDescriptor": "WhlBdy *Yoga 11-12"
            }
          },
          "partnerAccountID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
          "source": {
            "paymentMethodID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
            "achDetails": {
              "companyEntryDescription": "Gym dues",
              "originatingCompanyName": "Whole Body Fit"
            },
            "cardDetails": {
              "dynamicDescriptor": "WhlBdy *Yoga 11-12"
            }
          },
          "description": "string"
        },
        "ranOn": "2019-08-24T14:15:22Z",
        "ranTransferID": "761f3bb8-b7a6-45a9-b8f6-394ef8f68835",
        "status": "pending",
        "error": {
          "message": "string"
        }
      }
    ],
    "ownerAccountID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
    "partnerAccountID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
    "recur": {
      "recurrenceRule": "string",
      "runTransfer": {
        "amount": {
          "currency": "USD",
          "value": 1204
        },
        "destination": {
          "paymentMethodID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
          "achDetails": {
            "companyEntryDescription": "Gym dues",
            "originatingCompanyName": "Whole Body Fit"
          },
          "cardDetails": {
            "dynamicDescriptor": "WhlBdy *Yoga 11-12"
          }
        },
        "partnerAccountID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
        "source": {
          "paymentMethodID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
          "achDetails": {
            "companyEntryDescription": "Gym dues",
            "originatingCompanyName": "Whole Body Fit"
          },
          "cardDetails": {
            "dynamicDescriptor": "WhlBdy *Yoga 11-12"
          }
        },
        "description": "string"
      },
      "indefinite": true,
      "start": "2009-11-10T23:00:00Z"
    },
    "scheduleID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
    "sourceAccountID": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
    "createdOn": "2019-08-24T14:15:22Z",
    "updatedOn": "2019-08-24T14:15:22Z",
    "disabledOn": "2019-08-24T14:15:22Z"
  }
]

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

X-Moov-Version

string

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release. When no version is specified, the API defaults to v2024.01.00.

Path parameters

accountID

string <uuid> required

Query parameters

skip

integer <int64>

count

integer <int64>
Default: 200

hydrate

string
Possible values: accounts

Response

application/json

destinationAccount

object
Show child attributes

accountID

string required

displayName

string required

email

string

partnerAccount

object
Show child attributes

accountID

string required

displayName

string required

email

string

sourceAccount

object
Show child attributes

accountID

string required

displayName

string required

email

string

recur

object
Defines configuration for recurring transfers.
Show child attributes

recurrenceRule

string required
RRule as defined by RFC 5545 (https://www.rfc-editor.org/rfc/rfc5545#section-3.3.10). Generators available online at the following sites - https://freetools.textmagic.com/rrule-generator, https://jkbrzt.github.io/rrule/

runTransfer

object required
Defines the attributes of a transfer.
Show child attributes

amount

object required
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64> required

Quantity in the smallest unit of the specified currency.

In USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.

description

string required
Simple description to place on the transfer.

destination

object required
Show child attributes

paymentMethodID

string<uuid> required

achDetails

object
Show child attributes

companyEntryDescription

string [4 to 10] characters
An optional override of the default NACHA company entry description for a transfer.

originatingCompanyName

string [4 to 16] characters
An optional override of the default NACHA company name for a transfer.

cardDetails

object
Show child attributes

dynamicDescriptor

string [4 to 22] characters
An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.

partnerAccountID

string<uuid> required

source

object required
Show child attributes

paymentMethodID

string<uuid> required

achDetails

object
Show child attributes

companyEntryDescription

string [4 to 10] characters
An optional override of the default NACHA company entry description for a transfer.

originatingCompanyName

string [4 to 16] characters
An optional override of the default NACHA company name for a transfer.

cardDetails

object
Show child attributes

dynamicDescriptor

string [4 to 22] characters
An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.

indefinite

boolean
True if the RRule set runs indefinitely.

start

string<date-time>

createdOn

string<date-time>

description

string
Simple description to place on the transfer.

destinationAccountID

string<uuid>

disabledOn

string<date-time>

mode

string<enum>
The operating mode for an account.
Possible values: sandbox, production

occurrences

array
Show child attributes

canceledOn

string<date-time>

error

object
Contains details on why the occurrence errored.
Show child attributes

message

string

generated

boolean
True if this was generated by a RRule.

indefinite

boolean
True if the RRule set runs indefinitely.

mode

string
Sandbox or production account mode of this schedule.
The operating mode for an account.
Possible values: sandbox, production

occurrenceID

string<uuid>

ranOn

string<date-time>

ranTransferID

string<uuid>

runOn

string<date-time>

runTransfer

object
Defines the attributes of a transfer.
Show child attributes

amount

object required
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64> required

Quantity in the smallest unit of the specified currency.

In USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.

description

string required
Simple description to place on the transfer.

destination

object required
Show child attributes

paymentMethodID

string<uuid> required

achDetails

object
Show child attributes

companyEntryDescription

string [4 to 10] characters
An optional override of the default NACHA company entry description for a transfer.

originatingCompanyName

string [4 to 16] characters
An optional override of the default NACHA company name for a transfer.

cardDetails

object
Show child attributes

dynamicDescriptor

string [4 to 22] characters
An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.

partnerAccountID

string<uuid> required

source

object required
Show child attributes

paymentMethodID

string<uuid> required

achDetails

object
Show child attributes

companyEntryDescription

string [4 to 10] characters
An optional override of the default NACHA company entry description for a transfer.

originatingCompanyName

string [4 to 16] characters
An optional override of the default NACHA company name for a transfer.

cardDetails

object
Show child attributes

dynamicDescriptor

string [4 to 22] characters
An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.

scheduleID

string<uuid>

status

string<enum>
Status of the completed occurrence.
Possible values: pending, failed, completed

ownerAccountID

string<uuid>

partnerAccountID

string<uuid>

scheduleID

string<uuid>

sourceAccountID

string<uuid>

updatedOn

string<date-time>