Scheduled Transaction Object

id

string (UUID)

ID of the scheduled transaction in the RocketKOR system.

status

string enum, values: ACTIVE, SUSPENDED, FINISHED

Status of the scheduled transaction.

createdTransactionsCount

number (int32)

Number of transactions created for the scheduled transaction.

pendingTransactionsCount

number (int32)

If the schedule has an end date, shows the number of transactions scheduled but not yet created. If there is no end date, shows information about the schedule.

businessAccountId

string (UUID)

ID of the Business Account that contains the debit and credit accounts for the transaction.

metadata  

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

Use a maximum of 6 key/value pairs to store additional information with a transaction. ACH transactions must include one or more of the following metadata parameters.

The following metadata parameters are returned in the response.

debitFinancialAccountId

string (UUID)

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

creditFinancialAccountId

string (UUID)

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

transactionType

string enum, values: SEND, REQUEST, REVERSAL, RETURN, ADJUSTMENT, DEPOSIT, WITHDRAWAL

Type of transaction. The following values are supported:

• SEND  Push funds from a Financial Account to another Financial Account. Send transactions are originated on RocketKOR.
• REQUEST  Pull funds to a Financial Account from another Financial Account. Request transactions are originated on RocketKOR.
• REVERSAL  A transaction created by RocketKOR to reverse a SETTLED or CLEARED transaction. Reversal transactions are originated on RocketKOR.
• RETURN  Cancels the initial transaction. Return transactions are originated on RocketKOR.
• ADJUSTMENT  Used to correct a human or system error with a transaction, or to record a transaction that originated outside of RocketKOR. Adjustment transactions are originated on RocketKOR.
• DEPOSIT  Movement of funds into a RocketKOR Financial Account where the push is originated outside RocketKOR. Deposit transactions are originated outside of RocketKOR.
• WITHDRAWAL  Movement of funds out of a RocketKOR Financial Account where the pull is originated outside RocketKOR. Withdrawal transactions are originated outside of RocketKOR.

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 payment reasons.

paymentReason

string

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

amount

string (decimal)

Transaction amount. Must be a positive number. This amount will be transferred from the debit account to the credit account. 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. Must be a positive number. This amount will be transferred from the debit account to the credit account. The amount must conform to any transaction limits.

Supports 4 decimal places. For example, to specify 12.25%, use the value 0.1225.

Either amount or debitBalancePercent is required. The request will fail if both parameters are provided.

currency

string

Currency used for the transaction. Must be an ISO 4217 alpha 3-character currency code. RocketKOR supports USD and CAD currencies.

settlementPriority

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

default value: IMMEDIATE

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

• IMMEDIATE  Near real-time.
• SAME_DAY  Same business day.
• NEXT_DAY  Next business day.
• SCHEDULED  Reserved for future use.

This parameter is configurable for some RocketKOR solutions, such as ACH and Wire.

Notes:

• Push to Card transactions always use the IMMEDIATE settlement priority.
• Wire transactions currently allow the SAME_DAY and NEXT_DAY settlement priorities.

createdAt

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

Date and time the transaction was created in the RocketKOR system.

requestor

object

Entity that created the transaction.

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.

startDateTime

string (date-time)

Date and time to initiate the transaction. Must be provided in ISO 8601 format without the time zone designator. 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"

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 Region ID according to the IANA Time Zone Database (example: America/New_York is -04)

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 scheduled transaction. Required if recurrenceRule is provided.