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.
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:
solution
string enum, values: push-to-card, ach
Name of the RocketKOR solution used for the transaction batch. Possible values are:
description
string
Description of the transaction 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.
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:
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:
Transaction Batch Quick Info Object
{
"id": "65078464-2dd1-496a-8a07-7dfd9e36b0a0",
"businessAccountId": "77051b4b-4c5f-4f65-af6d-87a8b61f73a6",
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"transactionType": "SEND",
"solution": "push-to-card",
"description": "This is a batch",
"currency": "USD",
"transactionCount": 5000,
"totalAmount": 52450.26,
"status": "PENDING",
"createdAt": "2023-02-06T01:02:45.943Z",
"createdBy": {
"id": "4bd3aff1-cf97-4480-96f4-cfe3656500a3",
"type": "EMPLOYEE"
}
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.