Search Scheduled Transactions

Search for scheduled single-leg transactions (SLTs) and multi-leg transactions (MLTs) based on filters such as the requestor, solution, created date, amount, and Financial Accounts. Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.

Note The search is limited to scheduled SLTs and MLTs for the Business Account associated with the request access token.

Endpoint

GET /v2/scheduled-transactions

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

name

string

Full or partial name of the scheduled SLT/MLT. Case is ignored.

recordType

string enum, values: slt, mlt

Type of scheduled transaction. Possible values are:

slt Single-leg transaction
mlt Multi-leg transaction

scheduleType

string enum, values: once-off, recurring

Type of schedule used by the scheduled SLT/MLT. Possible values are:

once-off Creates a one-time transaction.
recurring Creates recurring transactions.

status

string enum, values: SCHEDULED, ACTIVE, SUSPENDED, CANCELLED, FINISHED

Status of the scheduled SLT/MLT. Possible values are:

SCHEDULED No transactions have been created yet.
ACTIVE (Recurring schedules only) The scheduled SLT/MLT is active. Transactions will be created according to the schedule.
SUSPENDED (Recurring schedules only) The scheduled SLT/MLT has been suspended.
CANCELLED The scheduled SLT/MLT has been cancelled.
FINISHED The scheduled SLT/MLT is complete.

requestorId

string (UUID)

ID of the entity that created the scheduled SLT/MLT.

requestorType

string enum, values: employee, service-account, internal

Type of entity that created the scheduled SLT/MLT. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

createdDateFrom

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

Date the scheduled SLT/MLT was created in the RocketKOR system. This filter will return SLTs/MLTs created on or after this date.

createdDateTo

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

Date the scheduled SLT/MLT was created in the RocketKOR system. This filter will return scheduled SLTs/MLTs created on or before this date.

timeZone

string

Time zone for the createdDateFrom and createdDateTo filters. The following values are supported:

Z, GMT, UTC or UT for the UTC time zone
zone offsets from UTC starting with + or – (example: +4)
zone offsets from UTC starting with UTC+, UTC+, GMT+, GMT-, UT+ or UT-
any other ID is parsed as Region ID according to the IANA Time Zone Database (example: America/New_York is -04)

amountFrom

number

Amount of the scheduled SLT/MLT. This filter will return scheduled SLTs/MLTs with an amount equal to or greater than this amount.

amountTo

number

Amount of the scheduled SLT/MLT. This filter will return scheduled SLTs/MLTs with an amount equal to or less than this amount.

debitFinancialAccountId

string (UUID)

ID of the Financial Account used as the debit account (source of funds) for the scheduled SLT/MLT.

creditFinancialAccountId

string (UUID)

ID of the Financial Account used as the credit account (receiver of funds) for the scheduled SLT/MLT.

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 Scheduled Transaction Summary objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "content": [
    {
      "recordType": "mlt",
      "id": "d30e7743-73bc-487a-b999-afd3915c1aad",
      "name": "MLT-123",
      "scheduleType": "recurring",
      "schedulerId": "086ccefa-19ae-4a4b-b1be-d88aac965d53",
      "amount": 1000.00,
      "debitFinancialAccounts": [
        {
          "name": "Debit",
          "category": "EXTERNAL",
          "accountHolderType": "CUSTOMER",
          "type": "CARD",
          "subtype": "DEBIT",
          "card": {
            "firstName": "John",
            "middleName": "David",
            "lastName": "Smith"
         }
        }
      ],
      "creditFinancialAccounts": [
        {
          "name": "Checking",
          "category": "EXTERNAL",
          "accountHolderType": "CUSTOMER",
          "type": "BANK",
          "subtype": "CHECKING",
          "bankAccount": {
            "bankName": "ABC Bank",
            "nameOnAccount": "Sally Jones"
          }
        }
      ],
      "createdBy": {
        "id": "ae88674e-8953-497c-b877-449bdedb6460",
        "type": "employee"
      },
      "createdAt": "2023-11-21T19:14:52.701Z",
      "timeZone": "UTC",
      "nextScheduledDate": "2023-12-21",
      "nextScheduledTime": "10:55",
      "remainingTransactions": 0
    },
    {...},
    {...}
  ]
}