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

Get an occurrence

Gets a specific occurrence.

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

GET
/accounts/{accountID}/schedules/{scheduleID}/occurrences/{occurrenceFilter}
cURL Go TypeScript PHP Python Java Ruby 
curl -X GET "https://api.moov.io/accounts/{accountID}/schedules/{scheduleID}/occurrences/{occurrenceFilter}" \
  -H "Authorization: Bearer {token}" \
  -H "x-moov-version: v2024.01.00" \

mc, _ := moov.NewClient()

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

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

import { SDK } from "openapi";

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

async function run() {
  const result = await sdk.scheduling.getOccurrance({
    accountID: "ea12b5d5-6249-4af2-ae48-6141a5251090",
    scheduleID: "289e94cd-66f1-4df5-999f-46d0f40b4ce9",
    occurrenceFilter: "<value>",
  });

  console.log(result);
}

run();
declare(strict_types=1);

require 'vendor/autoload.php';

use OpenAPI\OpenAPI;

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



$response = $sdk->scheduling->getOccurrance(
    accountID: 'ea12b5d5-6249-4af2-ae48-6141a5251090',
    scheduleID: '289e94cd-66f1-4df5-999f-46d0f40b4ce9',
    occurrenceFilter: '<value>'

);

if ($response->occurrencesResponse !== null) {
    // handle response
}
from openapi import SDK


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

    res = sdk.scheduling.get_occurrance(account_id="ea12b5d5-6249-4af2-ae48-6141a5251090", schedule_id="289e94cd-66f1-4df5-999f-46d0f40b4ce9", occurrence_filter="<value>")

    # Handle response
    print(res)
package hello.world;

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

public class Application {

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

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

        GetScheduledOccurrenceResponse res = sdk.scheduling().getOccurrance()
                .accountID("ea12b5d5-6249-4af2-ae48-6141a5251090")
                .scheduleID("289e94cd-66f1-4df5-999f-46d0f40b4ce9")
                .occurrenceFilter("<value>")
                .call();

        if (res.occurrencesResponse().isPresent()) {
            // handle response
        }
    }
}
require 'openapi'

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

res = s.scheduling.get_occurrance(account_id: 'ea12b5d5-6249-4af2-ae48-6141a5251090', schedule_id: '289e94cd-66f1-4df5-999f-46d0f40b4ce9', occurrence_filter: '<value>')

unless res.occurrences_response.nil?
  # handle response
end
200 401 403 404 429 500 504
The request completed successfully.
application/json
Example
{
  "scheduleID": "string",
  "occurrenceID": "string",
  "mode": "production",
  "generated": true,
  "indefinite": true,
  "canceledOn": "2019-08-24T14:15:22Z",
  "runOn": "2019-08-24T14:15:22Z",
  "runTransfer": {
    "amount": {
      "currency": "USD",
      "value": 1204
    },
    "salesTaxAmount": {
      "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",
    "lineItems": {
      "items": [
        {
          "name": "string",
          "basePrice": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "quantity": 1,
          "options": [
            {
              "name": "string",
              "quantity": 1,
              "priceModifier": {
                "currency": "USD",
                "valueDecimal": "12.987654321"
              },
              "group": "string",
              "images": [
                {
                  "imageID": "string",
                  "altText": "string",
                  "link": "https://api.moov.io/images/q7lKWleAy9fUNhEGezQ1g",
                  "publicID": "string"
                }
              ]
            }
          ],
          "productID": "string",
          "images": [
            {
              "imageID": "string",
              "altText": "string",
              "link": "https://api.moov.io/images/q7lKWleAy9fUNhEGezQ1g",
              "publicID": "string"
            }
          ]
        }
      ]
    }
  },
  "ranOn": "2019-08-24T14:15:22Z",
  "ranTransferID": "string",
  "status": "pending",
  "error": {
    "message": "string"
  }
}

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

string 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 dev 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 required

scheduleID

string required

occurrenceFilter

string required

Allows the specification of additional filters beyond the string.

Specifying a 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

runOn

string<date-time> required

runTransfer

object required
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 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 required

source

object required
Show child attributes

paymentMethodID

string 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.

lineItems

object
Line items for a scheduled transfer.
Show child attributes

items

array<object> required
The list of line items.
Show child attributes

basePrice

object
The base price of the item before applying option modifiers.
Show child attributes

currency

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

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

images

array<object>
Optional list of images associated with this line item.
Show child attributes

altText

string <=125 characters
Alternative text for the image.

imageID

string
Unique identifier for a image resource.

link

string<uri>
The image's public URL.

publicID

string Pattern
A unique identifier for an image, used in public image links.

name

string [1 to 150] characters
The name of the item.

options

array<object>
Optional list of modifiers applied to this item (e.g., toppings, upgrades, customizations).
Show child attributes

group

string <=100 characters
Optional group identifier to categorize related options (e.g., 'toppings').

images

array<object>
Optional list of images associated with this line item.
Show child attributes

altText

string <=125 characters
Alternative text for the image.

imageID

string
Unique identifier for a image resource.

link

string<uri>
The image's public URL.

publicID

string Pattern
A unique identifier for an image, used in public image links.

name

string [1 to 150] characters
The name of the option or modifier.

priceModifier

object
Optional price modification applied by this option. Can be positive, negative, or zero.
Show child attributes

currency

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

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

quantity

integer<int32>
The quantity of this option.

productID

string
Optional unique identifier associating the line item with a product.

quantity

integer<int32>
The quantity of this item.

salesTaxAmount

object
Optional sales tax amount. This amount is included in the total transfer amount.
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.

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

ranOn

string<date-time>

ranTransferID

string

scheduleID

string

status

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