Get a schedule

Get a schedule associated with accountID.

To use this endpoint from the browser, you’ll need to specify the /accounts/{your-account-id}/transfers.read scope when generating a token.

GET
/accounts/{accountID}/schedules/{scheduleID}
cURL Go
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)
200 429
Schedule returned
Describes a schedule of transfers to refund. Requires at least 1 occurrence or recurTransfer to be specified.
{
  "description": "string",
  "destinationAccountID": "90c0c8e8-98f5-4174-b30b-6840cf85c32a",
  "mode": "sandbox",
  "occurrences": [
    {
      "canceledOn": "2019-08-24T14:15:22Z",
      "error": {
        "message": "string"
      },
      "generated": true,
      "indefinite": true,
      "mode": "sandbox",
      "occurrenceID": "74fabb88-d79e-4e9e-b63b-2ddc96054e61",
      "ranOn": "2019-08-24T14:15:22Z",
      "ranTransferID": "761f3bb8-b7a6-45a9-b8f6-394ef8f68835",
      "runOn": "2019-08-24T14:15:22Z",
      "runTransfer": {
        "amount": {
          "currency": "USD",
          "value": 1204
        },
        "description": "string",
        "destination": {
          "achDetails": {
            "companyEntryDescription": "Gym Dues",
            "originatingCompanyName": "Whole Body Fit"
          },
          "cardDetails": {
            "dynamicDescriptor": "WhlBdy *Yoga 11-12"
          },
          "paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42"
        },
        "partnerAccountID": "c197cd40-7745-4413-8f3b-ec962d1b5225",
        "source": {
          "achDetails": {
            "companyEntryDescription": "Gym Dues",
            "originatingCompanyName": "Whole Body Fit"
          },
          "cardDetails": {
            "dynamicDescriptor": "WhlBdy *Yoga 11-12"
          },
          "paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42"
        }
      },
      "scheduleID": "b7aa2ee2-8783-4fc9-9fa6-a4720b30b20d",
      "status": "pending"
    }
  ],
  "ownerAccountID": "292371f0-0c0d-4018-aa97-b77545d5ce75",
  "partnerAccountID": "c197cd40-7745-4413-8f3b-ec962d1b5225",
  "recur": {
    "indefinite": true,
    "recurrenceRule": "FREQ=DAILY;COUNT=5",
    "runTransfer": {
      "amount": {
        "currency": "USD",
        "value": 1204
      },
      "description": "string",
      "destination": {
        "achDetails": {
          "companyEntryDescription": "Gym Dues",
          "originatingCompanyName": "Whole Body Fit"
        },
        "cardDetails": {
          "dynamicDescriptor": "WhlBdy *Yoga 11-12"
        },
        "paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42"
      },
      "partnerAccountID": "c197cd40-7745-4413-8f3b-ec962d1b5225",
      "source": {
        "achDetails": {
          "companyEntryDescription": "Gym Dues",
          "originatingCompanyName": "Whole Body Fit"
        },
        "cardDetails": {
          "dynamicDescriptor": "WhlBdy *Yoga 11-12"
        },
        "paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42"
      }
    },
    "start": "2019-08-24T14:15:22Z"
  },
  "scheduleID": "b7aa2ee2-8783-4fc9-9fa6-a4720b30b20d",
  "sourceAccountID": "c9fc70f7-3061-47a8-89e1-66c55f6542c7"
}
Request was refused due to rate limiting.

X-Retry-In

string <duration>
How long (in milliseconds) to wait until able to retry the request.

Path parameters

accountID

string <uuid> required
ID of the account.

scheduleID

string <uuid> required
ID of the schedule

Response

application/json
Describes a schedule of transfers to refund. Requires at least 1 occurrence or recurTransfer to be specified.

description

string
Simple description of what the schedule is.

destinationAccountID

string<uuid>
AccountID tied to the destination of the transfers, this cannot change once created.

mode

string<enum>
sandbox or production status of this schedule.
Possible values: sandbox, production

occurrences

array
Occurrences that have already been created
right_key Show child attributes

canceledOn

string<date-time>
Timestamp of when this occurrence was canceled. If set, this occurrence won’t run.

error

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

message

string

generated

boolean
True if this was generated by a RRule

indefinite

boolean
True if the RRule that generated this runs indefinitely

mode

string<enum>
sandbox or production status of this schedule.
Possible values: sandbox, production

occurrenceID

string<uuid>
ID of this specific occurrence

ranOn

string<date-time>
Timestamp of when it was confirmed to start the transfer

ranTransferID

string<uuid>
ID of the transfer that was created

runOn

string<date-time>
Timestamp to run the transfer after

runTransfer

object
Defines the attributes of a transfer
right_key Show child attributes

amount

object required
An integer value representing money in a specific currency.
right_key Show child attributes

currency

string <=3 characters Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64>
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.

destination

object required
Defines a payment method to use for the scheduled transfer
right_key Show child attributes

paymentMethodID

string<uuid> required
ID of the payment method to use.

achDetails

object
right_key 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
right_key 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
AccountID of the Moov partner in the transfer.

source

object required
Defines a payment method to use for the scheduled transfer
right_key Show child attributes

paymentMethodID

string<uuid> required
ID of the payment method to use.

achDetails

object
right_key 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
right_key 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.

description

string
Simple description to place on the transfer

scheduleID

string<uuid>
specific ID for this schedule

status

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

ownerAccountID

string<uuid>
AccountID of the creator of the schedule and the only one able to modify it.

partnerAccountID

string<uuid>
AccountID tied to the partner of the transfers, this cannot change once created.

recur

object
Defines configuration for recurring transfers
right_key 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
right_key Show child attributes

amount

object required
An integer value representing money in a specific currency.
right_key Show child attributes

currency

string <=3 characters Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64>
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.

destination

object required
Defines a payment method to use for the scheduled transfer
right_key Show child attributes

paymentMethodID

string<uuid> required
ID of the payment method to use.

achDetails

object
right_key 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
right_key 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
AccountID of the Moov partner in the transfer.

source

object required
Defines a payment method to use for the scheduled transfer
right_key Show child attributes

paymentMethodID

string<uuid> required
ID of the payment method to use.

achDetails

object
right_key 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
right_key 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.

description

string
Simple description to place on the transfer

indefinite

boolean
True if the RRule set runs indefinitely

start

string<date-time> <=24 characters

scheduleID

string<uuid>
specific ID for this schedule

sourceAccountID

string<uuid>
AccountID tied to the source of the transfers, this cannot change once created.