Transaction Schedule Summary Object

createdBy

object

Entity that created the SLT/MLT schedule.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the SLT/MLT schedule was created.

updatedBy

object

Entity that last updated the SLT/MLT schedule.

updatedAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the SLT/MLT schedule was last updated.

startDateTime  

string, pattern: ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[01])T([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])(\.[0-9]{1,6})?$

Date and time to initiate the SLT/MLT schedule. Must be provided in the following ISO 8601 format without the time zone designator:

year-month-dayThours:minutes:seconds[.fractions-of-second]

where:

• year is four digits
• month is two digits
• day is two digits
• T is the literal “T” character used to delimit a date portion from a time portion
• hours is two digits representing the number of hours from 00 to 23
• minutes is two digits representing the number of minutes from 00 to 59
• seconds is two digits representing the number of seconds from 00 to 59
• fractions-of-second (optional) is one or more digits representing a fraction of a second

Example: 2023‐08‐31T15:53:00.123

The date will be interpreted using the timeZone parameter, and UTC format will be used if timeZone is not provided.

For recurring transactions, this is the date and time when the recurrenceRule will take effect. For example, let’s say a request has the following parameters:

"startDateTime": "2023-08-31T12:00:00",

"recurrenceRule: "FREQ=WEEKLY;BYDAY=MO"

In this example, the start date is on a Thursday and the recurrence rule is weekly executions each Monday. Therefore the first transaction will be created on Monday, September 4th, at 12:00 pm in the specified time zone.

timeZone

string

Time zone for startDateTime. The following values are supported:

• Z, GMT, UTC or UT for the UTC time zone
• zone offsets from UTC starting with + or – (example: +4)
• zone offsets from UTC starting with UTC+, UTC+, GMT+, GMT-, UT+ or UT-
• any other ID is parsed as an IANA Time Zone Database region ID (example: the value for America/New_York is -04)

calendarType

string enum, values: BANKING, DEFAULT

Type of calendar to use for the SLT/MLT schedule.

• BANKING  Scheduled transactions will not be executed on a non-banking day, such as weekends and holidays, based on the country where the Business Account is legally identified.
• DEFAULT  Scheduled transactions will execute on any day, including non-banking days. Note that this may result in errors depending on the day the transaction is executed and the solution/provider used for the transaction.

recurrenceRule

string

Rule used to schedule transactions on a recurring basis. Must be specified using the IETF iCalendar RFC 5545 RRULE property.

For example, let’s say a request has the following parameters:

"timeZone": "America/New_York",

"startDateTime": "1997-09-02T09:00:00",

"recurrenceRule": "FREQ=DAILY;UNTIL=19971224T000000"

This request will create transactions at the following times:

September 2, 1997 to October 25, 1997 (inclusive) at 9:00 AM EDT

October 26, 1997 to December 23, 1997 (inclusive) at 9:00 AM EST

status

string enum, values: SCHEDULED, ACTIVE, SUSPENDED, DELETED, FINISHED

Status of the SLT/MLT schedule.

name

string, max length: 60

Name of the SLT/MLT schedule. Required if recurrenceRule is provided.

transactionType

string enum, values: SEND, REQUEST

Type of transaction created by the SLT/MLT schedule. The following values are supported:

• SEND  Push funds from the debit Financial Account to the credit Financial Account.

  For example, a SEND transaction would be used if a Business Account (owner of the debit Financial Account) is sending a refund to a Customer (owner of the credit Financial Account).

• REQUEST  Pull funds to the credit Financial Account from the debit Financial Account.

  For example, a REQUEST transaction would be used if a Business Account (owner of the credit Financial Account) is collecting a rent payment from a Customer (owner of the debit Financial Account).

id  

string (UUID)

ID of the SLT/MLT schedule.

scheduleType

string enum, values: once-off, recurring

Type of SLT/MLT schedule. Possible values are:

• once-off  Creates a one-time transaction.
• recurring  Creates recurring transactions.

schedulerId

string (UUID)

ID of the scheduling system for the SLT/MLT schedule.

amount

string (decimal)

Transaction amount for transactions created by the SLT/MLT schedule. The amount must conform to any transaction limits.

nextScheduledDate

string (date), format: yyyy-MM-dd

Next expected date for the SLT/MLT schedule to trigger a transaction.

nextScheduledTime

string (time), format: hh:ss

Next expected time for the SLT/MLT schedule to trigger a transaction.

remainingTransactions

number (int32)

Number of remaining transactions to be created for the SLT/MLT schedule.

metadata

string, max items: 6, value max length: 1024

Key/value pairs used to store additional information with the SLT/MLT schedule.

version

integer

Current version of the SLT/MLT schedule.

debitFinancialAccounts

array

Debit Financial Account used for the transactions created for the SLT/MLT schedule.

creditFinancialAccounts

array

Credit Financial Account used for the transactions created for the SLT/MLT schedule.