The Transaction Batch Summary object represents a batch file containing multiple transactions. This object does not contain details for the individual transactions in the batch file.
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).
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:
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.
status
string enum, values: PENDING, PROCESSING, COMPLETED, ERROR, CANCELLED
Current status of the transaction batch. The following values are supported:
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:
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:
updatedAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the transaction batch was last updated.
Transaction Batch Summary Object
{
"id": "string(UUID)",
"businessAccountId": "string(UUID)",
"metadata": {
"key": "value"
},
"transactionType": "SEND | REQUEST",
"solution": "string",
"initiatorAccountHolderId": "string(UUID)",
"externalTransactionInitiatorId": "string(UUID)",
"originatingChannel": "EXTERNAL | INTERNAL | PORTAL",
"description": "string",
"transactionCount": integer(int32),
"processedTransactionCount": integer(int32),
"failedTransactionCount": integer(int32),
"totalAmount": "string(currency)",
"processedTransactionAmount": "string(currency)",
"failedTransactionAmount": "string(currency),
"currency": "string",
"status": "PENDING | PROCESSING | COMPLETED | ERROR | CANCELLED",
"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.
