BI Transaction Object

rowNum

integer (int21)

Row number.

adjustmentReason

string, enum values: ERROR_CORRECTION, WITHDRAWAL_TRANSACTION, RECONCILIATION, DEPOSIT_TRANSACTION

Reason for the transaction adjustment.

amount

number

Transaction amount.

batchId

string

ID of the batch from which the transaction originated.

businessAccountId

string (UUID)

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

createdAt

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

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

createdById

string (UUID)

ID of the entity that created the transaction. Will be blank if createdByType is internal.

createdByType

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

Type of entity that created the transaction. 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.

creditFinancialAccountId

string (UUID)

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

creditFinancialAccountVersion

integer (int32)

Current version of the credit Financial Account.

currency

string

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

debitFinancialAccountId

string (UUID)

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

debitFinancialAccountVersion

integer (int32)

Current version of the debit Financial Account.

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.

externalTransactionInitiatorId

string

External identifier. Can be used to capture your internal ID for the user that initiated the transaction on the client application.

id

string (UUID)

Transaction ID.

idempotencyKey

string

A unique string that identifies the request. Can be a v4 UUID or any other unique string with a minimum length of 6 characters and a maximum length of 255 characters.

If a network error occurs, you can safely retry the request using the same idempotency key and the request will only be executed once. This ensures that calling the API multiple times will not result in duplicate requests. For more information, see Idempotent Calls.

initiatorAccountHolderId

string (UUID)

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

korMetadata

string

RockeKOR metadata.

latestTransactionStatus

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.

latestTransactionStatusId

string (UUID)

ID of the latest transaction status.

latestTransactionStatusJson

string

JSON for the latest transaction status.

maskedCreditAccountNumber

string

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

maskedDebitAccountNumber

string

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

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.

metadata

string

Key/value pairs used to store additional information about the transaction.

multiLegTransactionId

string (UUID)

Multi-leg transaction (MLT) ID.

originatingChannel

string enum, values: EXTERNAL, INTERNAL, PORTAL

Channel used to create the transaction. Possible values are:

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

parentTransactionId

string (UUID)

ID of the transaction’s parent transaction.

paymentReasonId

string

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

processedStatusEventIds

string

provider

string

Provider.

requestedSendDate

string (date-time)

reversalReason

string enum, values: DUPLICATE_PAYMENT, EARLY_DEBIT, LATE_CREDIT, INCORRECT_RECIPIENT, INCORRECT_AMOUNT

Applies to REVERSAL transactions only. Reason the transaction was reversed. The following values are supported:

• DUPLICATE_PAYMENT  The transaction is a duplicate transaction.
• EARLY_DEBIT  Applies to debit transactions. The date of the transaction is earlier than the date intended by the originator.
• LATE_CREDIT  Applies to credit transactions. The date of the transaction is later than the date intended by the originator.
• INCORRECT_RECIPIENT  The credit Financial Account is incorrect.
• INCORRECT_AMOUNT  The transaction amount is incorrect.

scheduledTransactionId

string (UUID)

ID of the transaction schedule.

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.

solution

string

Name of the RocketKOR solution used for the transaction.

sponsor

string

Sponsor.

transactionType

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

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).
• DEPOSIT  Push funds into a Financial Account where the push is originated outside RocketKOR.
• WITHDRAWAL  Pull funds from a Financial Account where the pull is originated outside RocketKOR.
• REVERSAL  A transaction created by RocketKOR to reverse a SETTLED or CLEARED transaction.
• RETURN  A RETURN transaction cancels the original transaction.
• ADJUSTMENT  An ADJUSTMENT transaction is used to correct a human or system error with a transaction or to record a transaction that originated outside of RocketKOR.

updatedAt

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

Date and time the transaction was last updated.