Transaction Batch Object

The Transaction Batch object represents a batch file containing multiple transactions. This object also contains details for the individual transactions in the batch file.

Attributes

id

string (UUID)

ID of the transaction batch in the RocketKOR system.

businessAccountId

string (UUID)

ID of the Business Account that contains the debit and credit accounts for the transactions in the batch.

metadata

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

Key/value pairs to store additional information with a transaction batch.

transactionType  

string enum, values: SEND, REQUEST

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

batchMode

string enum, values: RELAXED, STRICT

default value: RELAXED

Batch mode. The following values are supported:

  • RELAXED  RocketKOR will validate the request header only and not the transaction line items. Individual transactions may be rejected based on validation rules.
  • STRICT  RocketKOR applies zero-tolerance validation rules on the request header as well as the transaction line items. If one of the validation rules fail, the entire batch will be rejected.

solution  

string

Name of the RocketKOR solution used for the transaction batch.

initiatorAccountHolderId

string (UUID)

ID of the RocketKOR account that initiated the transaction batch. 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 batch on the client application.

originatingChannel

string enum, values: EXTERNAL, INTERNAL, PORTAL

Channel used to create the transaction batch. Possible values are:

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

description  

string

Description of the transaction batch.

settlementPriority

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

Expected priority for settling the transactions in the batch. 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:

  • Push-to-Card transactions always use the IMMEDIATE settlement priority.
  • Wire transactions only allow the SAME_DAY and NEXT_DAY settlement priorities.

currency  

string

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

transactionCount  

integer (int32)

Total number of transactions in the batch.

processedTransactionCount

integer (int32)

Total number of all successfully processed transactions in the batch.

failedTransactionCount

integer (int32)

Total number of all failed transactions in the batch.

totalAmount  

string (currency)

Total amount of all transactions in the batch.

processedTransactionAmount

string (currency)

Total amount of all successfully processed transactions in the batch.

failedTransactionAmount

string (currency)

Total amount of all failed transactions in the batch.

status

string enum, values: PENDING, PROCESSING, COMPLETED, ERROR, CANCELLED

Current status of the transaction batch. The following values are supported:

  • PENDING  The batch has been created.
  • PROCESSING  The batch is being processed.
  • COMPLETED  The batch has been completed.
  • ERROR  The batch is unusable.
  • CANCELLED  The batch has been cancelled.

transactions

object

Transactions in the batch.

id

string (UUID)

ID of the transaction in the RocketKOR system.

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.

paymentReasonId  

string

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

amount  

string (currency)

Transaction amount. The amount must conform to any transaction limits.

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.

id

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.

createdBy

object

Entity that created the transaction batch.

id

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

updatedBy

object

Entity that last updated the transaction batch.

id

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

Transaction Batch Object

				
					{
  "id": "string(UUID)",
  "businessAccountId": "string(UUID)",
  "metadata": {
    "key": "value"
  },
  "transactionType": "SEND | REQUEST",
  "batchMode": "RELAXED | STRICT",
  "solution": "string",
  "initiatorAccountHolderId": "string(UUID)",
  "externalTransactionInitiatorId": "string(UUID)",
  "originatingChannel": "EXTERNAL | INTERNAL | PORTAL",
  "description": "string",
  "settlementPriority": "IMMEDIATE | SAME_DAY | NEXT_DAY | SCHEDULED",
  "currency": "string",
  "transactionCount": integer(int32),
  "processedTransactionCount": integer(int32),
  "failedTransactionCount": integer(int32),
  "totalAmount": "string(currency)",
  "processedTransactionAmount": "string(currency)",
  "failedTransactionAmount": "string(currency),
  "status": "PENDING | PROCESSING | COMPLETED | ERROR | CANCELLED",
  "transactions": [
    {
      "id": "string(UUID)",
      "metadata": {
        "key": "value"
      },
      "debitFinancialAccountId": "string(UUID)",
      "creditFinancialAccountId": "string(UUID)",
      "paymentReasonId": "string",
      "amount": "string(currency)",
      "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)"
      }
    }
  ],
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "createdAt": "string(date-time)",
  "updatedBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "updatedAt": "string(date-time)"
}

Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.

A Rocket Financial Inc. company

@ 2024 RocketKOR, Inc. All rights reserved.

Terms of Use     |     Privacy Policy
Exit mobile version