SLT Schedule Detail Object

A single-leg transaction (SLT) schedule is used to automatically execute single-leg transactions at a future date and time. You can use an SLT schedule to execute a one-time transaction or a series of recurring transactions.

The SLT Schedule Detail object represents detailed information for an SLT schedule. This includes information for the schedule, the transaction(s) that will be created by the schedule, and the Financial Accounts used in the transaction(s).

Attributes

createdBy

object

Entity that created the SLT schedule.

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

createdAt

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

Date and time the SLT schedule was created.

updatedBy

object

Entity that last updated the SLT schedule.

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
internal Internal service call.
kor_employee Rocket Financial employee.
service-account Service Account using APIs.

updatedAt

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

Date and time the SLT 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 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 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

name

string, max length: 60

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

status

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

Status of the SLT schedule.

transactionType

string enum, values: SEND, REQUEST

Type of transactions created by the SLT 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).

string (UUID)

ID of the SLT schedule.

scheduleType

string enum, values: once-off, recurring

Type of SLT 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 schedule.

currency

string, min length: 3, max length: 3

Currency used for transactions created by the SLT schedule. Must be an ISO 4217 alpha 3-character currency code.

amount

string (decimal)

Total amount for all transactions created for the SLT schedule. Not applicable if a percentage was used for the transaction amount.

nextScheduledDate

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

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

nextScheduledTime

string (time), format: hh:ss

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

remainingTransactions

number (int32)

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

metadata

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

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

version

integer

Current version of the SLT schedule.

initiatorAccountHolderId

string (UUID)

ID of the RocketKOR account that initiated the SLT schedule. This can be a Business Account or a Customer Account.

originatingChannel

string enum, values: EXTERNAL, INTERNAL, PORTAL

Channel used to create the SLT schedule. Possible values are:

EXTERNAL RocketKOR APIs.
INTERNAL Internal service call.
PORTAL Team Member using the RocketKOR Portal.

debitFinancialAccounts

array

Debit Financial Account used for transactions created by the SLT schedule.

token

string, min length: 1, max length: 100

Token for the Financial Account.

provider

string (UUID)

Provider for the Financial Account.

currency

string, min length: 3, max length: 3

Currency of the Financial Account. Must be an ISO 4217 alpha 3-character currency code.

string (UUID)

ID of the Financial Account.

name

string, min length: 1, max length: 100

Name for the Financial Account. This is an informal name used for the account in RocketKOR.

maskedAccountNumber

string

Masked account number for the Financial Account (bank account number or card number).

state

string enum, values: ACTIVE, PENDING, SUSPENDED

Current status of the Financial Account. The following values are supported:

ACTIVE Financial Account is active.
PENDING Financial Account is being processed and is not yet active.
SUSPENDED Financial Account is inactive. Inactive Financial Accounts cannot be used in transactions.

sponsorFinancialAccountId

string (UUID)

Sponsor for the Financial Account.

financialInstitutionId

string (UUID)

ID of the financial institution.

parentId

string (UUID)

ID of the Parent Financial Account.

category

string enum, values: EXTERNAL, INTEGRATED, INTERNAL

Financial Account category. The following values are supported:

EXTERNAL Linked to an account that is issued or managed by an outside financial institution. Example: A debit card or bank account issued by a financial institution.
INTEGRATED Linked to a third-party account at a third-party institution. Example: A debit card or bank account issued on RocketKOR.
INTERNAL Created within RocketKOR to manage funds and track account balances for a Customer. Not linked to an account at a financial institution.

accountRoles

string enum, values: DEFAULT, SPONSOR, ADJUSTMENT, SETTLEMENT, FBO, SUSPENSE, ESCROW

Role of the Financial Account.

accountHolderId

string (UUID)

ID of the entity that owns the Financial Account. Returned if the account holder is a Customer or Recipient. This field is not returned if the account holder is a Business Account.

accountHolderType

string enum, values: CUSTOMER, RECIPIENT

Type of entity that owns the Financial Account. Returned if the account holder is a Customer or Recipient. Omitted if the account holder is a Business Account.

businessAccountId

string (UUID)

ID of the Business Account that contains the Financial Account.

type

string enum, values: BANK, CARD

Type of Financial Account. The following values are supported:

BANK Bank account
CARD Debit, credit, or prepaid card

subtype

string enum; values for BANK Financial Accounts: CHECKING, SAVING; values for CARD Financial Accounts: CREDIT, DEBIT, PREPAID

Financial Account subtype.

Values supported for BANK Financial Accounts: SAVING, CHECKING
Values supported for CARD Financial Accounts: CREDIT, DEBIT, PREPAID

version

integer

Current version of the Financial Account.

externalBalanceAmount

string (decimal)

External balance for the Financial Account. Only available for external bank Financial Accounts.

externalBalanceEffectiveAt

string (date-time)

Effective date and time of the external account balance. Only available for external bank Financial Accounts.

restrictions

object

Restrictions for the Financial Account.

solution

string

Allowed Move Money solutions for the Financial Account.

transactionType

string

Allowed transaction types for the Financial Account.

withholdingPeriod

string (duration)

Withholding period for the Financial Account.

inherited

boolean

Whether the Financial Account has inherited the restrictions of the parent account.

bankAccount

object

Returned if a bank account is attached to the Financial Account. Note that either the bankAccount or card object is returned.

bankName

string

Name of the financial institution.

routingNo

string, max length: 9

Routing number for the financial institution.

accountNumberTail

string, max length: 4

Last 4 digits of the bank account number.

nameOnAccount

string, min length: 1, max length: 40

Name of the bank account owner.

businessName

string, min length: 1, max length: 40

Business name as it appears on the bank account.

address

object

Address for the bank account.

addressLine1

string, min length: 1, max length: 50

Address line 1.

addressLine2

string, min length: 1, max length: 50

Address line 2.

addressLine3

string, min length: 1, max length: 50

Address line 3.

city

string, min length: 1, max length: 25

City.

stateCode

string, min length: 2, max length: 3

countryCode

string, min length: 3, max length: 3

Country. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.

postalCode

string, min length: 1, max length: 10

card

object

Returned if a card is attached to the Financial Account. Note that either the bankAccount or card object is returned.

firstName

string, min length: 1, max length: 40

Customer’s first name as it appears on the card.

middleName

string, min length: 1, max length: 40

Customer’s middle name as it appears on the card.

lastName

string, min length: 1, max length: 40

Customer’s last name as it appears on the card.

expiry

string, format: yyyy-MM

Expiry date for the card.

address

object

Address for the card.

addressLine1

string, min length: 1, max length: 50

Address line 1.

addressLine2

string, min length: 1, max length: 50

Address line 2.

addressLine3

string, min length: 1, max length: 50

Address line 3.

city

string, min length: 1, max length: 25

City.

stateCode

string, min length: 2, max length: 3

countryCode

string, min length: 3, max length: 3

Country. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.

postalCode

string, min length: 1, max length: 10

paymentReason

string

Payment reason for transactions created by the SLT schedule. Use the Payment Reasons API to retrieve a list of available payment reasons.

transactionSpec

object

Details for the transaction(s) created by the SLT schedule.

metadata

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

Key/value pairs used to store additional information about the transaction. ACH transactions must include one or more of the following metadata parameters.

Parameter	Description
rkorACHEntryType	Required for all ACH transactions. ACH Standard Entry Class (SEC) code. The following codes are supported. For more information, see ACH File Details. ARC Accounts Receivable Entry BOC Back Office Conversion CCD Cash Concentration or Disbursement CIE Customer Initiated Entry CTX Corporate Trade Exchange IAT International POP Point of Purchase Entry PPD Prearranged Payment and Deposit Entry RCK Re-Presented Check Entry TEL Telephone-Initiated Entry WEB Internet Initiated Entry
rkorACHIndividualId	Required if rkorACHEntryType is CIE, PPD, or TEL. Individual Identification Number.
rkorACHCheckSerialNumber	Required if rkorACHEntryType is ARC, BOC, POP, or RCK. Serial number of the check from a Converted Check Copy.
rkorACHTerminalCity	Required if rkorACHEntryType is POP. Terminal city.
rkorACHTerminalState	Required if rkorACHEntryType is POP. Terminal state.

The following metadata parameters are returned in the response.

Parameter	Description
rkorProvider	ACH Provider. Possible values are PAYGEARS and SNB.
rkorReasonCode	Return Reason Code. Present in RETURN transaction responses.
rkorReasonDescription	Return Reason Description. Present in RETURN transaction responses.
rkorDiscretionaryData	Return Transaction Identifier. Present in RETURN transaction responses.

debitFinancialAccountId

string (UUID)

ID of the Financial Account used as the debit account (source of funds) for the transaction.

creditFinancialAccountId

string (UUID)

ID of the Financial Account used as the credit account (receiver of funds) for the transaction.

transactionType

string enum, values: SEND, REQUEST

Type of transaction. 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).

solution

string

Name of the RocketKOR solution used for the transaction.

paymentReasonId

string

ID representing the payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available IDs.

amount

string (decimal)

Transaction amount.

The amount must conform to any transaction limits.
Either amount or debitBalancePercent is required. The request will fail if both parameters are provided.

debitBalancePercent

string (decimal)

Percentage of the debitFinancialAccountId balance to use as the transaction amount. Supports 4 decimal places. For example, to specify 12.25%, use the value 0.1225.

The amount must conform to any transaction limits.
Either amount or debitBalancePercent is required. The request will fail if both parameters are provided.

settlementPriority

string enum, values: IMMEDIATE, SAME_DAY, NEXT_DAY, SCHEDULED

Required for ACH transactions. Optional for Wire transactions. Not required for Push-to-Card transactions.

Expected priority for settling the transaction. The following values are supported:

IMMEDIATE Near real-time. Push-to-Card transactions always use the IMMEDIATE settlement priority. Not available for ACH And Wire transactions.
SAME_DAY Same business day. Available for ACH And Wire transactions.
NEXT_DAY Next business day. Available for ACH And Wire transactions.
SCHEDULED Reserved for future use.

Note If settlementPriority is not specified for ACH transactions, the value NEXT_DAY will be used.

initiatorAccountHolderId

string (UUID)

ID of the RocketKOR account that initiated the transaction. This can be a Business Account or a Customer Account.

currency

string

Currency used for the transaction. Must be an ISO 4217 alpha 3-character currency code.

description

string, max length: 100

Required for the Wire solution. Not available for other solutions.

Brief description of the transaction. If the value exceeds the maximum length, the value will be truncated to 100 characters when the transaction is submitted for processing.

memo

string, max length: 100

Only available for the Wire solution.

Brief additional note about the transaction. If the value exceeds the maximum length, the value will be truncated to 100 characters when the transaction is submitted for processing.

SLT Schedule Detail Object

				
					{
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "createdAt": "string(date-time)",
  "updatedBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "updatedAt": "string(date-time)",
  "startDateTime": "string(date-time)",
  "timeZone": "string",
  "calendarType": "BANKING | DEFAULT",
  "recurrenceRule": "string",
  "name": "string",
  "status": "SCHEDULED | ACTIVE | SUSPENDED | DELETED | FINISHED",
  "transactionType": "SEND | REQUEST",
  "id": "string(UUID)",
  "scheduleType": "once-off | recurring",
  "schedulerId": "string(UUID)",
  "currency": "string",
  "amount": "string(decimal)",
  "nextScheduledDate": "string(date)",
  "nextScheduledTime": "string(time)",
  "remainingTransactions": number(int32),
  "metadata": {
    "key": "value"
  },
  "version": integer,
  "initiatorAccountHolderId": "string(UUID)",
  "originatingChannel": "EXTERNAL | INTERNAL | PORTAL",
  "debitFinancialAccounts": [
    {
      "token": "string",
      "provider": "string(UUID)",
      "currency": "string"
      "id": "string(UUID)"
      "name": "string",
      "maskedAccountNumber": "string",
      "state": "PENDING | ACTIVE | SUSPENDED",
      "sponsorFinancialAccountId": "string(UUID)",
      "financialInstitutionId": "string(UUID)",
      "parentId": "string(UUID)",
      "category": "EXTERNAL | INTEGRATED | INTERNAL",
      "accountRoles": "DEFAULT | SPONSOR | ADJUSTMENT | SETTLEMENT | FBO | SUSPENSE | ESCROW",
      "accountHolderId": "string(UUID)", // omitted if the account holder is a Business Account
      "accountHolderType": "CUSTOMER", // omitted if the account holder is a Business Account
      "businessAccountId": "string(UUID)",
      "type": "BANK | CARD",
      "subtype": "CHECKING | SAVING | CREDIT | DEBIT | PREPAID",
      "version": "integer(int32)",
      "externalBalanceAmount": "string(decimal)",
      "externalBalanceEffectiveAt": "string(date-time)",
      "restrictions": {
        "solution": "string",
        "transactionType": "string",
        "withholdingPeriod": "string(duration)",
        "inherited": boolean
      },
      "bankAccount": { // bankAccount or card is returned
        "bankName": "string",
        "routingNo": "string",
        "accountNumberTail": "string",
        "nameOnAccount": "string",
        "businessName": "string",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "city": "string",
          "stateCode": "string",
          "countryCode": "string",
          "postalCode": "string"
        }
      },
      "card": { // bankAccount or card is returned
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "expiry": "string",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "city": "string",
          "stateCode": "string",
          "countryCode": "string",
          "postalCode": "string"
        }
      }
    }
  ],
  "creditFinancialAccounts": [
    {
      "token": "string",
      "provider": "string(UUID)",
      "currency": "string"
      "id": "string(UUID)"
      "name": "string",
      "maskedAccountNumber": "string",
      "state": "PENDING | ACTIVE | SUSPENDED",
      "sponsorFinancialAccountId": "string(UUID)",
      "financialInstitutionId": "string(UUID)",
      "parentId": "string(UUID)",
      "category": "EXTERNAL | INTEGRATED | INTERNAL",
      "accountRoles": "DEFAULT | SPONSOR | ADJUSTMENT | SETTLEMENT | FBO | SUSPENSE | ESCROW",
      "accountHolderId": "string(UUID)", // omitted if the account holder is a Business Account
      "accountHolderType": "CUSTOMER | RECIPIENT", // omitted if the account holder is a Business Account
      "businessAccountId": "string(UUID)",
      "type": "BANK | CARD",
      "subtype": "CHECKING | SAVING | CREDIT | DEBIT | PREPAID",
      "version": "integer(int32)",
      "externalBalanceAmount": "string(decimal)",
      "externalBalanceEffectiveAt": "string(date-time)",
      "restrictions": {
        "solution": "string",
        "transactionType": "string",
        "withholdingPeriod": "string(duration)",
        "inherited": boolean
      },
      "bankAccount": { // bankAccount or card is returned
        "bankName": "string",
        "routingNo": "string",
        "accountNumberTail": "string",
        "nameOnAccount": "string",
        "businessName": "string",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "city": "string",
          "stateCode": "string",
          "countryCode": "string",
          "postalCode": "string"
        }
      },
      "card": { // bankAccount or card is returned
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "expiry": "string",
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "city": "string",
          "stateCode": "string",
          "countryCode": "string",
          "postalCode": "string"
        }
      }
    }
  ],
  "paymentReason": "string",
  "transactionSpec": {
    "metadata": {
      "key": "value"
    },
    "debitFinancialAccountId": "string(UUID)",
    "creditFinancialAccountId": "string(UUID)",
    "transactionType": "SEND | REQUEST",
    "solution": "string",
    "paymentReasonId": "string",
    "amount": "string(decimal)", // amount or debitBalancePercent is returned
    "debitBalancePercent": "string(decimal)", // amount or debitBalancePercent is returned
    "settlementPriority": "IMMEDIATE | SAME_DAY | NEXT_DAY | SCHEDULED",
    "initiatorAccountHolderId": "string(UUID)",
    "currency": "string",
    "description": "string",
    "memo": "string"
  }
}