Transaction Batch Quick Info Object

The Transaction Batch Quick Info object represents a batch file containing multiple transactions. This object does not contain details for the individual transactions in the batch file.

Attributes

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

Use a maximum of 6 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 a Financial Account to another Financial Account.
REQUEST Pull funds to a Financial Account from another Financial Account.

solution

string

Name of the RocketKOR solution used for the transaction batch.

description

string

Description of the transaction batch.

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.

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.

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.

createdBy

object

Entity that created the transaction batch.

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

updatedBy

object

Entity that last updated the transaction batch.

string (UUID)

ID of the entity. Will be blank if updatedBy.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.

updatedAt

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

Date and time the transaction batch was last updated.

Transaction Batch Quick Info Object

				
					{
  "id": "65078464-2dd1-496a-8a07-7dfd9e36b0a0",
  "businessAccountId": "77051b4b-4c5f-4f65-af6d-87a8b61f73a6",
  "metadata": {
    "department": "billing"
  },
  "transactionType": "SEND",
  "solution": "push-to-card",
  "description": "This is a batch",
  "transactionCount": 5000,
  "processedTransactionCount": 4998,
  "failedTransactionCount": 2,
  "totalAmount": "52450.26",
  "processedTransactionAmount": "49813.26",
  "failedTransactionAmount": "2637.00,
  "currency": "USD",
  "status": "PENDING",
  "createdBy": {
    "id": "e1b97aa1-29a8-46d3-8f58-aa7a8bec5e79",
    "type": "service-account"
  },
  "createdAt": "2023-02-06T01:02:45.943Z",
  "updatedBy": {
    "id": "e1b97aa1-29a8-46d3-8f58-aa7a8bec5e79",
    "type": "service-account"
  },
  "updatedAt": "2023-02-08T20:40:03.484Z"
}