MLT Schedule Detail Object

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

The MLT Schedule object represents detailed information for an MLT 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 MLT 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 MLT schedule was created.

updatedBy

object

Entity that last updated the MLT 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 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 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 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

name

string, max length: 60

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

status

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

Status of the MLT schedule.

transactionType

string enum, values: SEND, REQUEST

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

string (UUID)

ID of the MLT schedule.

scheduleType

string enum, values: once-off, recurring

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

currency

string

Currency for the debit (funding leg ) and credit (disbursement leg) transactions. Must be an ISO 4217 alpha 3-character currency code.

amount

string (decimal)

Total amount for all transaction(s) created for the MLT schedule. Not applicable if a percentage was used for the transaction amount.

nextScheduledDate

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

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

nextScheduledTime

string (time), format: hh:ss

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

remainingTransactions

number (int32)

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

metadata

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

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

version

integer

Current version of the MLT schedule.

originatingChannel

string enum, values: EXTERNAL, INTERNAL, PORTAL

Channel used to create the MLT 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 MLT 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. This field is not returned if the account holder is a Business Account.

accountHolderType

string enum, values: CUSTOMER

Type of entity that owns the Financial Account. Returned if the account holder is a Customer. 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

State, province, or territory. Required if country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code. For example, Missouri is MO and Ontario is ON.

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

ZIP code or postal code. For US addresses, must be a valid value of 5 digits (example: 63368) or 5 digits-4 digits (example: 63368-5555). Can be alphanumeric for other countries with a maximum length of 10 characters.

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

creditFinancialAccounts

array

Credit Financial Account used for transactions created for the MLT 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

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

debits

array

Debit transaction for the MLT funding leg. This transaction is used to obtain funds from the debit Financial Account.

sequence

integer

Sequence number. Indicates the transaction’s position in the debits array.

financialAccountId

string (UUID)

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

maskedAccountNumber

string

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

paymentReasonId

string

ID representing the payment reason for the transaction. For the MLT debit transaction, paymentReasonId uses a fixed value of funds_transfer.

amount

string (decimal)

Transaction amount. The amount must conform to any transaction limits.

Either amount or amountPercentage is required. The request will fail if both parameters are provided.
If the debit transaction includes amount, the credit transaction cannot include amountPercentage.
If the transaction is created using amountPercentage, the response amount will show the actual transaction value.

amountPercentage

string (decimal)

Percentage of the debit Financial Account balance to use as the transaction amount. The amount must conform to any transaction limits.

Either amount or amountPercentage is required. The request will fail if both parameters are provided.
If the debit transaction includes amountPercentage, the credit transaction cannot include amount.
If the transaction is created using amountPercentage, the response amount will show the actual transaction value.

settlementPriority

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

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:

For MLT ACH transactions, the default value is SAME_DAY.
Push-to-Card transactions always use the IMMEDIATE settlement priority.
Wire transactions only allow the SAME_DAY and NEXT_DAY settlement priorities.

transactionId

string (UUID)

ID of the debit transaction.

solution

string

Name of the RocketKOR solution used for the transaction. MLT debit transactions currently use the ACH solution.

latestStatus

object

Current status of the transaction.

status

string enum, values: NEW, PENDING, PROCESSING, APPROVED, SETTLED, CLEARED, CANCELLED, DECLINED, REVERSED, ERROR

Transaction status. The following values are supported:

NEW The transaction has been created in RocketKOR.
PENDING The transaction has been moved from the RocketKOR Transaction Domain to one of the RocketKOR Processing Domains. The transaction is still in the RocketKOR system (meaning it has not been transmitted to the Provider for processing) and is in a state where it can be cancelled.
PROCESSING One of the following is true: (a) the transaction is in a RocketKOR Processing Domain but can no longer be cancelled, or (b) the transaction has been transmitted to the Provider for processing.
APPROVED Disbursement has been approved by the Provider.
SETTLED The transaction has been settled by the Provider.
CLEARED The Sponsor has indicated that funds movement for the transaction is complete. The funds are now available in the Master Settlement Account (MSA). This status is only applicable for “received” transactions.
CANCELLED The transaction has been cancelled.
DECLINED Disbursement has been declined by the Provider.
REVERSED A transaction was submitted by RocketKOR to move funds in the opposite direction of the initial transaction. This “reverses” the transaction by moving the funds back to the original account.
ERROR The transaction could not be processed due to one or more errors (for example, the Provider system is unavailable after a number of retries). The ERROR status is only activated after RocketKOR determines that it cannot continue processing the transaction.

message

string

Description of the status change.

createdBy

object

Entity that created the transaction status.

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 status was assigned to the transaction.

_embedded

object

Embedded subresources for the debit transaction. Includes details for the Financial Account and account holder.

financialAccount

object

Details for the Financial Account used in the transaction.

name

string, min length: 1, max length: 100

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

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.

accountHolderType

string enum, values: CUSTOMER

Type of entity that owns the Financial Account. Returned if the account holder is a Customer. Omitted if the account holder is a Business 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

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.

nameOnAccount

string, min length: 1, max length: 40

Name of the bank account owner.

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.

maskedAccountNumber

string

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

accountHolderId

string (UUID)

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

credits

array

Credit transaction for the MLT disbursement leg. This transaction is used to disburse funds to the credit Financial Account.

sequence

integer

Sequence number. Indicates the transaction’s position in the credits array.

financialAccountId

string (UUID)

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

maskedAccountNumber

string

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

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.

If the debit transaction includes amountPercentage, the credit transaction cannot include amount.
If provided, amount must be the same as the debit transaction amount.
Either amount or amountPercentage can be provided. The request will fail if both parameters are provided.
If the transaction is created using amountPercentage, the response amount will show the actual transaction value.

amountPercentage

string (decimal)

Percentage of the debit Financial Account balance to use as the transaction amount. The amount must conform to any transaction limits.

If the debit transaction includes amount, the credit transaction cannot include amountPercentage.
If provided, amountPercentage must be the same as the debit transaction amountPercentage.
Either amount or amountPercentage can be provided. The request will fail if both parameters are provided.
If the transaction is created using amountPercentage, the response amount will show the actual transaction value.

settlementPriority

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

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:

For MLT ACH transactions, the default value is SAME_DAY.
Push-to-Card transactions always use the IMMEDIATE settlement priority.
Wire transactions only allow the SAME_DAY and NEXT_DAY settlement priorities.

transactionId

string (UUID)

ID of the credit transaction.

solution

string

Name of the RocketKOR solution used for the transaction.

latestStatus

object

Current status of the transaction.

status

string enum, values: NEW, PENDING, PROCESSING, APPROVED, SETTLED, CLEARED, CANCELLED, DECLINED, REVERSED, ERROR

Transaction status. The following values are supported:

NEW The transaction has been created in RocketKOR.
PENDING The transaction has been moved from the RocketKOR Transaction Domain to one of the RocketKOR Processing Domains. The transaction is still in the RocketKOR system (meaning it has not been transmitted to the Provider for processing) and is in a state where it can be cancelled.
PROCESSING One of the following is true: (a) the transaction is in a RocketKOR Processing Domain but can no longer be cancelled, or (b) the transaction has been transmitted to the Provider for processing.
APPROVED Disbursement has been approved by the Provider.
SETTLED The transaction has been settled by the Provider.
CLEARED The Sponsor has indicated that funds movement for the transaction is complete. The funds are now available in the Master Settlement Account (MSA). This status is only applicable for “received” transactions.
CANCELLED The transaction has been cancelled.
DECLINED Disbursement has been declined by the Provider.
REVERSED A transaction was submitted by RocketKOR to move funds in the opposite direction of the initial transaction. This “reverses” the transaction by moving the funds back to the original account.
ERROR The transaction could not be processed due to one or more errors (for example, the Provider system is unavailable after a number of retries). The ERROR status is only activated after RocketKOR determines that it cannot continue processing the transaction.

message

string

Description of the status change.

createdBy

object

Entity that created the transaction status.

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 status was assigned to the transaction.

_embedded

object

Embedded subresources for the credit transaction. Includes details for the Financial Account and account holder.

financialAccount

object

Details for the Financial Account used in the transaction.

name

string, min length: 1, max length: 100

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

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.

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.

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

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.

nameOnAccount

string, min length: 1, max length: 40

Name of the bank account owner.

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

First name of the Customer or Recipient, as it appears on the card.

middleName

string, min length: 1, max length: 40

Middle name of the Customer or Recipient, as it appears on the card.

lastName

string, min length: 1, max length: 40

Last name of the Customer or Recipient, as it appears on the card.

maskedAccountNumber

string

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

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.

MLT 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,
  "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": {
        "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)",
      "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",
  "debits": [
    {
      "sequence": integer,
      "financialAccountId": "string(UUID)",
      "maskedAccountNumber": "string",
      "paymentReasonId": "string",
      "amount": "string(decimal)",
      "amountPercentage": "string(decimal)",
      "settlementPriority": "IMMEDIATE | SAME_DAY | NEXT_DAY | SCHEDULED",
      "transactionId": "string(UUID)",
      "solution": "string",
      "latestStatus": {
        "status": "NEW | PENDING | PROCESSING | APPROVED | SETTLED | CLEARED | CANCELLED | DECLINED | REVERSED | ERROR",
        "message": "string(date-time)",
        "createdBy": {
          "id": "string(UUID)",
          "type": "employee | internal | kor_employee | service-account"
        },
        "createdAt": "string(date-time)"
      },
      "_embedded": {
        "financialAccount": {
          "name": "string",
          "category": "EXTERNAL | INTEGRATED | INTERNAL",
          "accountHolderType": "CUSTOMER", // omitted if the account holder is a Business Account
          "type": "BANK | CARD",
          "subtype": "CHECKING | SAVING | CREDIT | DEBIT | PREPAID",
          "bankAccount": { // bankAccount or card is returned
            "bankName": "string",
            "nameOnAccount": "string"
          },
          "card": { // bankAccount or card is returned
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
          },
          "maskedAccountNumber": "string"
        },
        "accountHolderId": "string(UUID)" // omitted if the account holder is a Business Account
      }
    }
  ],
  "credits": [
    {
      "sequence": integer,
      "financialAccountId": "string(UUID)",
      "maskedAccountNumber": "string",
      "paymentReasonId": "string",
      "amount": "string(decimal)",
      "amountPercentage": "string(decimal)",
      "settlementPriority": "IMMEDIATE | SAME_DAY | NEXT_DAY | SCHEDULED",
      "transactionId": "string(UUID)",
      "solution": "string",
      "latestStatus": {
        "status": "NEW | PENDING | PROCESSING | APPROVED | SETTLED | CLEARED | CANCELLED | DECLINED | REVERSED | ERROR",
        "message": "string(date-time)",
        "createdBy": {
          "id": "string(UUID)",
          "type": "employee | internal | kor_employee | service-account"
        },
        "createdAt": "string(date-time)"
      },
      "_embedded": {
        "financialAccount": {
          "name": "string",
          "category": "EXTERNAL | INTEGRATED | INTERNAL",
          "accountHolderType": "CUSTOMER | RECIPIENT", // omitted if the account holder is a Business Account
          "type": "BANK | CARD",
          "subtype": "CHECKING | SAVING | CREDIT | DEBIT | PREPAID",
          "bankAccount": { // bankAccount or card is returned
            "bankName": "string",
            "nameOnAccount": "string"
          },
          "card": { // bankAccount or card is returned
            "firstName": "string",
            "middleName": "string",
            "lastName": "string"
          },
          "maskedAccountNumber": "string"
        },
        "accountHolderId": "string(UUID)" // omitted if the account holder is a Business Account
      }
    }
  ]
}