Transaction Status Change

transactionId

string (UUID)

Transaction ID.

debitFinancialAccountId

string (UUID)

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

maskedDebitAccountNumber

string

Masked account number of the debit Financial Account.

debitAccountHolderId

string (UUID)

Account holder ID for the debit Financial Account.

debitAccountHolderType

string, enum values: BUSINESS_ACCOUNT, CUSTOMER, EMPLOYEE, RECIPIENT

Account holder type for the debit Financial Account.

creditFinancialAccountId

string (UUID)

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

maskedCreditAccountNumber

string

Masked account number of the credit Financial Account.

creditAccountHolderId

string (UUID)

Account holder ID for the credit Financial Account.

creditAccountHolderType

string, enum values: BUSINESS_ACCOUNT, CUSTOMER, EMPLOYEE, RECIPIENT

Account holder type for the credit Financial Account.

transactionType

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

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.

adjustmentReason

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

Reason for the transaction adjustment.

paymentReasonId

string

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

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.

amount

number

Transaction amount.

solution

string

Name of the RocketKOR solution used for the transaction.

requestorId

string (UUID)

ID of the entity that created the transaction.

requestorType

string, enum values: BUSINESS_ACCOUNT, CUSTOMER, EMPLOYEE, RECIPIENT

Type of entity that created the transaction.

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.

businessAccountId

string (UUID)

ID of the Business Account.

parentTransactionId

string (UUID)

ID of the transaction’s parent transaction.

metadata

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

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

transactionStatus

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

Transaction status. The following values are supported:

• NEW  The transaction has been created in RocketKOR.
• PENDING  The transaction has been moved from the Transaction Domain to one of the 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 Processing Domain in the RocketKOR system 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 to “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.
• DEPOSIT_WITHHELD  The funds for the deposit transaction have been cleared and are in a withholding period. This means that the funds are not yet available in the Financial Account.

createdAt

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

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