RocketKOR

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)

Unique ID for 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

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

transactionType

string enum, value: SEND, REQUEST

Type of transaction. Possible values are:

  • SEND  Push funds from a Financial Account to another Financial Account.
  • REQUEST  Pull funds to a Financial Account from another Financial Account.

batchMode

string enum, values: RELAXED, STRICT

default: RELAXED

Batch mode. Possible values are:

  • 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 enum, values: push-to-card, ach

Name of the RocketKOR solution used for the transaction batch. Possible values are:

  • push-to-card  Push to Card solution.
  • ach  ACH solution.

description

string

Description of the transaction batch.

settlementPriority

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

default: IMMEDIATE

Expected priority for settling the transactions in the batch. Possible values are:

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

currency

string

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

transactionCount

integer (int32)

Total number of transactions in the batch.

totalAmount

number

Total amount of all transactions in the batch.

status

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

Current status of the transaction batch. Possible values are:

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

Unique ID for the transaction in the RocketKOR system.

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 for the Financial Account used as the debit account (source of the funds) for the transaction.

creditFinancialAccountId

string (UUID)

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

paymentReasonId

string

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

amount

string

Amount to be transferred from the debit account to the credit account. Must be a positive number.

Note  This 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. Possible values are:

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

createdAt

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

Date and time the status was assigned to the transaction.

createdAt

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

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

createdBy

object

Entity that requested the transaction batch creation.

id

string (UUID)

ID of the entity that requested the transaction batch creation.

type

string enum, values: EMPLOYEE, SERVICE_ACCOUNT

Type of entity that requested the transaction batch creation. Possible values are:
  • EMPLOYEE  Team Member using the RocketKOR Portal.
  • SERVICE_ACCOUNT  Service Account using APIs.

Transaction Batch Object

				
					{
  "id": "65078464-2dd1-496a-8a07-7dfd9e36b0a0",
  "businessAccountId": "77051b4b-4c5f-4f65-af6d-87a8b61f73a6",
  "metadata": {
    "myPaymentId": "100000333",
    "invoiceNumber": "123232333",
    "authorizedBy": "user@email.com"
  },
  "transactionType": "SEND",
  "batchMode": "RELAXED",
  "solution": "push-to-card",
  "description": "This is a batch",
  "settlementPriority": "SAME_DAY",
  "currency": "USD",
  "transactionCount": 5000,
  "totalAmount": 52450.26,
  "status": "PENDING",
  "transactions": [
    {
      "id": "ce0c8e6d-f747-4aff-b607-8a6d1a10968c",
      "metadata": {
        "myPaymentId": "100000333",
        "invoiceNumber": "123232333",
        "authorizedBy": "user@email.com"
      },
      "debitFinancialAccountId": "00303bff-29af-4213-bc7d-d9127a16927e",
      "creditFinancialAccountId": "cf2944c7-465b-427c-b933-4d33526b391a",
      "paymentReasonId": "loan-payouts",
      "amount": "250.00",
      "latestStatus": {
        "status": "NEW",
        "message": "New transaction",
        "createdAt": "2023-02-06T01:02:45.943Z"
      }
    },
    {...},
    {...}
  ],
  "createdAt": "2023-04-06T01:02:45.943Z",
  "createdBy": {
    "id": "4bd3aff1-cf97-4480-96f4-cfe3656500a3",
    "type": "EMPLOYEE"
  }
}