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

Get a schedule

Describes a schedule associated with an account. Requires at least 1 occurrence or recurTransfer to be specified.

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

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

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

1
2
3
4
5
6

mc, _ := moov.NewClient()

var accountID string
var scheduleID string

mc.GetSchedule(ctx, accountID, scheduleID)

 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
26
27
28

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->scheduling->get(
    accountID: '31afd98b-eb55-41b3-8a4f-0ee8ea69e4e0',
    scheduleID: '55487e07-f3b7-44e8-b6f3-64fc85701c34',
    xMoovVersion: 'v2024.01.00'

);

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

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.scheduling.get(account_id="31afd98b-eb55-41b3-8a4f-0ee8ea69e4e0", schedule_id="55487e07-f3b7-44e8-b6f3-64fc85701c34")

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

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.scheduling.get({
    accountID: "b888f774-3e7c-4135-a18c-6b985523c4bc",
    scheduleID: "e50f7622-81da-484b-9c66-1c8a99c6b71b",
  });

  // Handle the result
  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
25
26
27
28

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.GetSchedulesResponse;
import java.lang.Exception;

public class Application {

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

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        GetSchedulesResponse res = sdk.scheduling().get()
                .accountID("31afd98b-eb55-41b3-8a4f-0ee8ea69e4e0")
                .scheduleID("55487e07-f3b7-44e8-b6f3-64fc85701c34")
                .call();

        if (res.scheduleResponse().isPresent()) {
            // handle response
        }
    }
}
200 401 403 404 429 500 504
The request completed successfully.
Example
{
  "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.
The requested resource was not found.

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
API version

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.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

scheduleID

string <uuid> required

Response

application/json

createdOn

string<date-time> required

destinationAccountID

string<uuid> required

mode

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

ownerAccountID

string<uuid> required

partnerAccountID

string<uuid> required

scheduleID

string<uuid> required

sourceAccountID

string<uuid> required

updatedOn

string<date-time> required

description

string
Simple description to place on the transfer.

disabledOn

string<date-time>

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

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>