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}
|
|
|
|
|
|
|
|
|
|
|
|
The request completed successfully.
{
"properties": {
"createdOn": {
"format": "date-time",
"type": "string"
},
"description": {
"description": "Simple description to place on the transfer.",
"type": "string"
},
"destinationAccountID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
},
"disabledOn": {
"format": "date-time",
"type": "string"
},
"mode": {
"description": "The operating mode for an account.",
"enum": [
"sandbox",
"production"
],
"example": "production",
"type": "string"
},
"occurrences": {
"items": {
"properties": {
"canceledOn": {
"format": "date-time",
"type": "string"
},
"error": {
"description": "Contains details on why the occurrence errored.",
"properties": {
"message": {
"type": "string"
}
},
"type": "object"
},
"generated": {
"description": "True if this was generated by a RRule.",
"type": "boolean"
},
"indefinite": {
"description": "True if the RRule set runs indefinitely.",
"type": "boolean"
},
"mode": {
"allOf": [
{
"description": "The operating mode for an account.",
"enum": [
"sandbox",
"production"
],
"example": "production",
"type": "string"
}
],
"description": "Sandbox or production account mode of this schedule."
},
"occurrenceID": {
"format": "uuid",
"type": "string"
},
"ranOn": {
"format": "date-time",
"type": "string"
},
"ranTransferID": {
"format": "uuid",
"type": "string"
},
"runOn": {
"format": "date-time",
"type": "string"
},
"runTransfer": {
"description": "Defines the attributes of a transfer.",
"properties": {
"amount": {
"properties": {
"currency": {
"description": "A 3-letter ISO 4217 currency code.",
"example": "USD",
"pattern": "^[A-Za-z]{3}$",
"type": "string"
},
"value": {
"description": "Quantity in the smallest unit of the specified currency. \n\nIn USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.",
"example": 1204,
"format": "int64",
"type": "integer"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"description": {
"description": "Simple description to place on the transfer.",
"type": "string"
},
"destination": {
"properties": {
"achDetails": {
"properties": {
"companyEntryDescription": {
"description": "An optional override of the default NACHA company entry description for a transfer.",
"example": "Gym dues",
"maxLength": 10,
"minLength": 4,
"type": "string"
},
"originatingCompanyName": {
"description": "An optional override of the default NACHA company name for a transfer.",
"example": "Whole Body Fit",
"maxLength": 16,
"minLength": 4,
"type": "string"
}
},
"type": "object"
},
"cardDetails": {
"properties": {
"dynamicDescriptor": {
"description": "An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.",
"example": "WhlBdy *Yoga 11-12",
"maxLength": 22,
"minLength": 4,
"type": "string"
}
},
"type": "object"
},
"paymentMethodID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
}
},
"required": [
"paymentMethodID"
],
"type": "object"
},
"partnerAccountID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
},
"source": {
"properties": {
"achDetails": {
"properties": {
"companyEntryDescription": {
"description": "An optional override of the default NACHA company entry description for a transfer.",
"example": "Gym dues",
"maxLength": 10,
"minLength": 4,
"type": "string"
},
"originatingCompanyName": {
"description": "An optional override of the default NACHA company name for a transfer.",
"example": "Whole Body Fit",
"maxLength": 16,
"minLength": 4,
"type": "string"
}
},
"type": "object"
},
"cardDetails": {
"properties": {
"dynamicDescriptor": {
"description": "An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.",
"example": "WhlBdy *Yoga 11-12",
"maxLength": 22,
"minLength": 4,
"type": "string"
}
},
"type": "object"
},
"paymentMethodID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
}
},
"required": [
"paymentMethodID"
],
"type": "object"
}
},
"required": [
"amount",
"destination",
"partnerAccountID",
"source",
"description"
],
"type": "object"
},
"scheduleID": {
"format": "uuid",
"type": "string"
},
"status": {
"description": "Status of the completed occurrence.",
"enum": [
"pending",
"failed",
"completed"
],
"type": "string"
}
},
"required": [
"runOn",
"runTransfer"
],
"type": "object"
},
"type": "array"
},
"ownerAccountID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
},
"partnerAccountID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
},
"recur": {
"description": "Defines configuration for recurring transfers.",
"properties": {
"indefinite": {
"description": "True if the RRule set runs indefinitely.",
"type": "boolean"
},
"recurrenceRule": {
"description": " RRule as defined by RFC 5545 (https://www.rfc-editor.org/rfc/rfc5545#section-3.3.10). \n Generators available online at the following sites - https://freetools.textmagic.com/rrule-generator, https://jkbrzt.github.io/rrule/",
"type": "string"
},
"runTransfer": {
"description": "Defines the attributes of a transfer.",
"properties": {
"amount": {
"properties": {
"currency": {
"description": "A 3-letter ISO 4217 currency code.",
"example": "USD",
"pattern": "^[A-Za-z]{3}$",
"type": "string"
},
"value": {
"description": "Quantity in the smallest unit of the specified currency. \n\nIn USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.",
"example": 1204,
"format": "int64",
"type": "integer"
}
},
"required": [
"currency",
"value"
],
"type": "object"
},
"description": {
"description": "Simple description to place on the transfer.",
"type": "string"
},
"destination": {
"properties": {
"achDetails": {
"properties": {
"companyEntryDescription": {
"description": "An optional override of the default NACHA company entry description for a transfer.",
"example": "Gym dues",
"maxLength": 10,
"minLength": 4,
"type": "string"
},
"originatingCompanyName": {
"description": "An optional override of the default NACHA company name for a transfer.",
"example": "Whole Body Fit",
"maxLength": 16,
"minLength": 4,
"type": "string"
}
},
"type": "object"
},
"cardDetails": {
"properties": {
"dynamicDescriptor": {
"description": "An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.",
"example": "WhlBdy *Yoga 11-12",
"maxLength": 22,
"minLength": 4,
"type": "string"
}
},
"type": "object"
},
"paymentMethodID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
}
},
"required": [
"paymentMethodID"
],
"type": "object"
},
"partnerAccountID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
},
"source": {
"properties": {
"achDetails": {
"properties": {
"companyEntryDescription": {
"description": "An optional override of the default NACHA company entry description for a transfer.",
"example": "Gym dues",
"maxLength": 10,
"minLength": 4,
"type": "string"
},
"originatingCompanyName": {
"description": "An optional override of the default NACHA company name for a transfer.",
"example": "Whole Body Fit",
"maxLength": 16,
"minLength": 4,
"type": "string"
}
},
"type": "object"
},
"cardDetails": {
"properties": {
"dynamicDescriptor": {
"description": "An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.",
"example": "WhlBdy *Yoga 11-12",
"maxLength": 22,
"minLength": 4,
"type": "string"
}
},
"type": "object"
},
"paymentMethodID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
}
},
"required": [
"paymentMethodID"
],
"type": "object"
}
},
"required": [
"amount",
"destination",
"partnerAccountID",
"source",
"description"
],
"type": "object"
},
"start": {
"example": "2009-11-10T23:00:00Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"recurrenceRule",
"runTransfer"
],
"type": "object"
},
"scheduleID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
},
"sourceAccountID": {
"example": "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
"format": "uuid",
"type": "string"
},
"updatedOn": {
"format": "date-time",
"type": "string"
}
},
"required": [
"destinationAccountID",
"mode",
"ownerAccountID",
"partnerAccountID",
"scheduleID",
"sourceAccountID",
"createdOn",
"updatedOn"
],
"type": "object"
}
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 yearQQ
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.
- For example,
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>