Transaction Object

The Transaction object represents the movement of funds between two RocketKOR Financial Accounts using a SEND, REQUEST, or REVERSAL transaction. These transaction types are originated on the RocketKOR system.

Attributes

string (UUID)

ID of the transaction in the RocketKOR system.

businessAccountId

string (UUID)

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

metadata

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

Use a maximum of 6 key/value pairs to store additional information with a transaction.

debitFinancialAccountId

string (UUID)

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

creditFinancialAccountId

string (UUID)

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

transactionType

string enum, values: SEND, REQUEST, REVERSAL

Type of transaction. The following values are supported:

SEND Push funds from a Financial Account to another Financial Account.
REQUEST Pull funds to a Financial Account from another Financial Account.
REVERSAL A transaction created by RocketKOR to reverse a SETTLED or CLEARED transaction.

SEND, REQUEST, and REVERSAL transactions are originated on RocketKOR.

solution

string

Name of the RocketKOR solution used for the transaction.

paymentReasonId

string

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

paymentReason

string

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

amount

string (currency)

Amount to be transferred from the debit account to the credit account. Must be a positive number. The amount must conform to any transaction limits.

currency

string

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

settlementPriority

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

default value: IMMEDIATE

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

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

This parameter is configurable for some RocketKOR solutions, such as ACH. Note that Push to Card transactions always use the IMMEDIATE settlement priority.

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

message

string

Success or error message related to the transaction.

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, service-account, internal

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

createdAt

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

Date and time the status was assigned to the transaction.

createdBy

object

Entity that created the transaction.

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

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

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

createdAt

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

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

reversalReason

string enum, values: DUPLICATE_PAYMENT, INCORRECT_RECIPIENT, INCORRECT_AMOUNT

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

DUPLICATE_PAYMENT The transaction was a duplicate transaction.
INCORRECT_RECIPIENT The debit or credit Financial Account was incorrect.
INCORRECT_AMOUNT The transaction amount was incorrect.

description

string, max length: 100

Required for the Wire solution. Not available for other solutions. Brief description of the transaction.

If the value exceeds the maximum length, the value will be truncated to 100 characters when the transaction is submitted for processing.

memo

string, max length: 100

Only available for the Wire solution. Brief additional note about the transaction.

If the value exceeds the maximum length, the value will be truncated to 100 characters when the transaction is submitted for processing.

Transaction Object

				
					{
  "id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
  "businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
  "metadata": {
    "myPaymentId": "100000333",
    "invoiceNumber": "123232333",
    "authorizedBy": "user@email.com"
  },
  "debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "transactionType": "SEND",
  "solution": "ach",
  "paymentReasonId": "loan-payouts",
  "paymentReason": "Loan Payouts",
  "amount": "1000.00",
  "currency": "USD",
  "settlementPriority": "SAME_DAY",
  "latestStatus": {
    "status": "NEW",
    "message": "Transaction creation successful",
    "createdBy": {
      "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
      "type": "service-account"
    },
    "createdAt": "2021-07-01T17:40:22.601Z"
  },
  "createdBy": {
    "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
    "type": "service-account"
  },
  "createdAt": "2021-07-01T17:40:22.601Z",
  "reversalReason": "",
  "description": "",
  "memo": ""
}