Retrieve a Transaction Batch

Retrieve details for a transaction batch file. Details for the individual transactions in the batch are not returned.

Endpoint

GET /v1/transaction-batches/{batchId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

batchId REQUIRED

string (UUID)

ID of the transaction batch in the RocketKOR system.

Request Body

None

Returns

Returns the Transaction Batch Summary object. This object contains details for the transaction batch file.

SAMPLE RESPONSE

				
					{
  "id": "65078464-2dd1-496a-8a07-7dfd9e36b0a0",
  "businessAccountId": "77051b4b-4c5f-4f65-af6d-87a8b61f73a6",
  "metadata": {
    "department": "billing"
  },
  "transactionType": "SEND",
  "solution": "ach",
  "initiatorAccountHolderId": "ebfa3e16-63c4-48e3-ae59-a3194a867269",
  "externalTransactionInitiatorId": "c62d1e6b-39ce-496e-bf6d-8a019d2f534e",
  "originatingChannel": "EXTERNAL",
  "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"
}