SLT Object

The Single-Leg Transaction (SLT) object represents the movement of funds between two RocketKOR Financial Accounts.

An SLT requires two Financial Accounts: a debit account and a credit account. These accounts must belong to the Business Account associated with the request access token. In an SLT, the move money operation is performed in a single stage or “leg”. The same transaction is used to obtain funds from a debit account, then transfer the funds to a credit account.

Attributes

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

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.

debitFinancialAccountId

string (UUID)

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

creditFinancialAccountId

string (UUID)

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

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.

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

paymentReason

string

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

amount

string (decimal)

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

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.

createdAt

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

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

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

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.

initiatorAccountHolderId

string (UUID)

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

externalTransactionInitiatorId

string

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

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.

string (UUID)

ID of the transaction in the RocketKOR system.

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.

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.

SLT Object

				
					{
  "businessAccountId": "string(UUID)",
  "metadata": {
    "key": "value"
  },
  "debitFinancialAccountId": "string(UUID)",
  "creditFinancialAccountId": "string(UUID)",
  "transactionType": "SEND | REQUEST | REVERSAL | RETURN | ADJUSTMENT | DEPOSIT | WITHDRAWAL",
  "solution": "string",
  "paymentReasonId": "string",
  "paymentReason": "string",
  "amount": "string(decimal)",
  "currency": "string",
  "settlementPriority": "IMMEDIATE | SAME_DAY | NEXT_DAY | SCHEDULED",
  "createdAt": "string(date-time)",
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "description": "string",
  "memo": "string",
  "initiatorAccountHolderId": "string(UUID)",
  "externalTransactionInitiatorId": "string(UUID)",
  "originatingChannel": "EXTERNAL | INTERNAL | PORTAL",
  "id": "string(UUID)",
  "latestStatus": {
    "status": "NEW | PENDING | PROCESSING | APPROVED | SETTLED | CLEARED | CANCELLED | DECLINED | REVERSED | ERROR",
    "message": "string",
    "createdBy": {
      "id": "string(UUID)",
      "type": "employee | internal | kor_employee | service-account"
    },
    "createdAt": "string(date-time)"
  },
  "reversalReason": "DUPLICATE_PAYMENT | EARLY_DEBIT | LATE_CREDIT | INCORRECT_RECIPIENT | INCORRECT_AMOUNT"
}