List Events for a Transaction Schedule

Retrieve a list of the events that have been created for a single-leg transaction (SLT) schedule or multi-leg transaction (MLT) schedule. The list can be filtered by the transaction creation date.

Endpoint

GET /v2/scheduled-transactions/{id}/scheduled-events

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

id REQUIRED

string (UUID)

ID of the SLT/MLT schedule.

Query Parameters

createdDateFrom

string (date), format: yyyy-MM-dd

Date the transaction was created in the RocketKOR system. This filter will return transactions created on or after this date.

Note The date is interpreted using the timeZone value specified in the transaction schedule. UTC format is used if timeZone was not provided.

createdDateTo

string (date), format: yyyy-MM-dd

Date the transaction was created in the RocketKOR system. This filter will return transactions created on or before this date.

Note The date is interpreted using the timeZone value specified in the transaction schedule. UTC format is used if timeZone was not provided.

embed

string, values: fromAccountHolderId, fromFinancialAccount, toAccountHolderId, toFinancialAccount

Available for MLT schedules only.

Specify subresources to embed in the response. The following subresources can be requested:

fromAccountHolderId ID of the account holder for the debit Financial Account.
fromFinancialAccount Details for the debit Financial Account.
toAccountHolderId ID of the account holder for the credit Financial Account.
toFinancialAccount Details for the credit Financial Account.

Use a comma-separated list to return multiple subresources (example: fromAccountHolderId,toAccountHolderId).

sort

array [string]

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of SLT Schedule Event objects or MLT Schedule Event objects. These objects represent a transaction that has been created for an SLT or MLT schedule.

SAMPLE RESPONSE (SLT Schedule Event Object)

				
					{
  "businessAccountId": "bf8714ed-501e-4a48-a11d-d2613350b643",
  "metadata": {
    "rkorACHEntryType": "CCD",
    "myPaymentId": "100000333",
    "invoiceNumber": "123232333",
    "authorizedBy": "user@email.com"
  },
  "debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "transactionType": "SEND",
  "solution": "ach",
  "paymentReasonId": "bill-payment",
  "paymentReason": "Bill payment",
  "amount": "1000.00",
  "currency": "USD",
  "settlementPriority": "SAME_DAY",
  "createdAt": "2023-10-30T21:12:32.366Z",
  "createdBy": {
    "id": "fd1c6009-a35c-4ddf-a4c8-dd946af7b647",
    "type": "service-account"
  },
  "description": "",
  "memo": "",
  "initiatorAccountHolderId": "ebfa3e16-63c4-48e3-ae59-a3194a867269",
  "originatingChannel": "EXTERNAL",
  "id": "7c195208-6801-4cf8-a7e2-74b790084331",
  "latestStatus": {
    "status": "NEW",
    "message": "Transaction creation successful",
    "createdBy": {
      "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
      "type": "service-account"
    },
    "createdAt": "2021-07-01T17:40:22.601Z"
  },
  "reversalReason": ""
}