MLT Detail Object

The Multi-Leg Transaction (MLT) Detail object represents the movement of funds using an MLT. The object contains detailed MLT information, including details about the MLT, details for the individual debit and credit transactions, and detailed information for the Financial Accounts used in the debit and credit transactions.

Attributes

currency

string

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

totalAmount

string (decimal)

Total amount of all transactions defined in the MLT.

metadata

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

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

name

string, max length: 60

Descriptive name for the MLT.

description

string

Description of the MLT.

memo

string

Brief note about the MLT.

initiatorAccountHolderId

string (UUID)

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

originatingChannel

string enum, values: EXTERNAL, INTERNAL, PORTAL

Channel used to create the MLT. Possible values are:

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

string (UUID)

ID of the MLT.

businessAccountId

string (UUID)

ID of the Business Account that contains the debit and credit Financial Accounts for the MLT.

stage

string enum, values: FUNDING, DISBURSING, CANCELLING

Current stage of the MLT. The following values are supported:

FUNDING A new MLT has been created in RocketKOR. The MLT will remain in the FUNDING stage until all of the debit (funding leg) transactions have cleared or the MLT is cancelled.
DISBURSING The debit (funding leg) transactions have cleared and the MLT has transitioned to the disbursement leg.
CANCELLING The MLT has been cancelled.

status

string enum, values: PENDING, PROCESSING, FAILED, CANCELLED, COMPLETE

Current status of the MLT. The following values are supported:

PENDING The MLT is waiting to be processed.
PROCESSING The MLT debit (funding leg) and credit (disbursement leg) transactions are being processed.
FAILED One or more of the MLT transactions has failed. Other transactions may be in process or completed. For possible ways to resolve a failed MLT, see the Update an MLT and Cancel an MLT APIs.
CANCELLED The MLT has been cancelled.
COMPLETE The MLT credit (disbursement leg) transactions have been completed.

debitAmountPending

string (decimal)

Total amount of debit (funding leg) transactions that have not yet been completed.

debitAmountCleared

string (decimal)

Total amount of debit (funding leg) transactions that have been cleared.

creditAmountPending

string (decimal)

Total amount of credit (disbursement leg) transactions that have not yet been completed.

creditAmountSettled

string (decimal)

Total amount of credit (disbursement leg) transactions that have been settled.

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.

financialAccount

object

Additional details for the debit 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.

routingNo

string, max length: 9

Routing number for the financial institution.

accountNumberTail

string, max length: 4

Last 4 digits of the bank account number.

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

maskedAccountNumber

string

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

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.

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.

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.

businessAccountId

string (UUID)

ID of the Business Account that contains the Financial Account.

version

integer (int32)

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.

paymentReason

string

Description of the payment reason for the transaction. For the MLT debit transaction, paymentReason uses a fixed value of Funds Transfer.

provider

string

Provider for the transaction.

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.

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.

solution

string

Name of the RocketKOR solution used for the transaction.

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.

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.

financialAccount

object

Additional details for the credit 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.

routingNo

string, max length: 9

Routing number for the financial institution.

accountNumberTail

string, max length: 4

Last 4 digits of the bank account number.

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

maskedAccountNumber

string

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

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.

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.

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.

businessAccountId

string (UUID)

ID of the Business Account that contains the Financial Account.

version

integer (int32)

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.

paymentReason

string

Description of the payment reason for the transaction. For the MLT debit transaction, paymentReason uses a fixed value of Funds Transfer.

provider

string

Provider for the transaction.

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.

createdBy

object

Entity that created the MLT.

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 was created in the RocketKOR system.

updatedBy

object

Entity that last updated the MLT.

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 was last updated.

version

integer

Current version of MLT.

parentId

string (UUID)

ID of the schedule that created the MLT.

MLT Detail Object

				
					{
  "currency": "string",
  "totalAmount": "string(decimal)",
  "metadata": {
    "key": "value"
  },
  "name": "string",
  "description": "string",
  "memo": "string",
  "initiatorAccountHolderId": "string(UUID)",
  "originatingChannel": "EXTERNAL | INTERNAL | PORTAL",
  "id": "string(UUID)",
  "businessAccountId": "string(UUID)",
  "stage": "FUNDING | DISBURSING | CANCELLING",
  "status": "PENDING | PROCESSING | FAILED | CANCELLED | COMPLETE",
  "debitAmountPending": "string(decimal)",
  "debitAmountCleared": "string(decimal)",
  "creditAmountPending": "string(decimal)",
  "creditAmountSettled": "string(decimal)",
  "debits": [
    {
      "sequence": integer,
      "financialAccountId": "string(UUID)",
      "maskedAccountNumber": "string",
      "paymentReasonId": "string",
      "amount": "string(decimal)", // amount or amountPercentage is returned
      "amountPercentage": "string(decimal)", // amount or amountPercentage is returned
      "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 | interal | kor_employee | service-account"
        },
        "createdAt": "string(date-time)"
      },
      "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",
          "routingNo": "string",
          "accountNumberTail": "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"
          }
        },
        "maskedAccountNumber": "string",
        "token": "string",
        "provider": "string(UUID)",
        "currency": "string",
        "id": "string(UUID)",
        "state": "ACTIVE | PENDING | SUSPENDED",
        "sponsorFinancialAccountId": "string(UUID)",
        "financialInstitutionId": "string(UUID)",
        "parentId": "string(UUID)",
        "accountRoles": "DEFAULT | SPONSOR | ADJUSTMENT | SETTLEMENT | FBO | SUSPENSE | ESCROW",
        "accountHolderId": "string(UUID)", // omitted if the account holder is a Business Account
        "businessAccountId": "string(UUID)",
        "version": integer,
        "externalBalanceAmount": "string(decimal)",
        "externalBalanceEffectiveAt": "string(date-time)",
        "restrictions" {
          "solution": "string",
          "transactionType": "string",
          "withholdingPeriod": "string(duration)",
          "inherited": boolean,
        }
      },
      "paymentReason": "string",
      "provider": "string",
      "metadata": {
        "key": "value"
      }
    }
  ],
  "credits": [
    {
      "sequence": integer,
      "financialAccountId": "string(UUID)",
      "maskedAccountNumber": "string",
      "paymentReasonId": "string",
      "amount": "string(decimal)", // amount or amountPercentage is returned
      "amountPercentage": "string(decimal)", // amount or amountPercentage is returned
      "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 | interal | kor_employee | service-account"
        },
        "createdAt": "string(date-time)"
      },
      "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",
          "routingNo": "string",
          "accountNumberTail": "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"
          }
        },
        "maskedAccountNumber": "string",
        "token": "string",
        "provider": "string(UUID)",
        "currency": "string",
        "id": "string(UUID)",
        "state": "ACTIVE | PENDING | SUSPENDED",
        "sponsorFinancialAccountId": "string(UUID)",
        "financialInstitutionId": "string(UUID)",
        "parentId": "string(UUID)",
        "accountRoles": "DEFAULT | SPONSOR | ADJUSTMENT | SETTLEMENT | FBO | SUSPENSE | ESCROW",
        "accountHolderId": "string(UUID)", // omitted if the account holder is a Business Account
        "businessAccountId": "string(UUID)",
        "version": integer,
        "externalBalanceAmount": "string(decimal)",
        "externalBalanceEffectiveAt": "string(date-time)",
        "restrictions" {
          "solution": "string",
          "transactionType": "string",
          "withholdingPeriod": "string(duration)",
          "inherited": boolean,
        }
      },
      "paymentReason": "string",
      "provider": "string",
      "metadata": {
        "key": "value"
      }
    }
  ],
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | interal | kor_employee | service-account"
  },
  "createdAt": "string(date-time)",
  "updatedBy": {
    "id": "string(UUID)",
    "type": "employee | interal | kor_employee | service-account"
  },
  "updatedAt": "string(date-time)",
  "version": integer,
  "parentId": "string(UUID)"
}