Get an occurrence

Gets a specific occurrence.

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}/occurrences/{occurrenceFilter}

cURL Go

1
2


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

1
2
3
4
5
6
7


mc, _ := moov.NewClient()

var accountID string
var scheduleID string
var filter func() string

mc.GetScheduleOccurrence(ctx, accountID, scheduleID, filter)

200 429

Singular occurrence matching the filter

Defines an occurrence for when to run a transfer

{
  "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"
}

Request was refused due to rate limiting.

Retry-After


      number

Path parameters

accountID


      string
      <uuid>

required

ID of the account.

scheduleID


      string
      <uuid>

required

ID of the schedule

occurrenceFilter


      string

required

Allows the specification of additional filters beyond the UUID.

Specifying a UUID string returns the exact occurrence
Specifying a RFC 3339 timestamp returns the latest occurrence at or before that timestamp
Specifying ’latest’ returns the latest occurrence at or before now

Response

application/json

Defines an occurrence for when to run a transfer

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

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

Show child attributes

amount


        object

required

An integer value representing money in a specific currency.

Show child attributes

currency


        string

<=3 characters

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

Show child attributes

paymentMethodID


        string<uuid>

required

ID of the payment method to use.

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

AccountID of the Moov partner in the transfer.

source


        object

required

Defines a payment method to use for the scheduled transfer

Show child attributes

paymentMethodID


        string<uuid>

required

ID of the payment method to use.

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.

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

Get an occurrence

Response headers

Was this helpful?