Search Scheduled Transactions

Search for single-leg transaction (SLT) schedules and multi-leg transaction (MLT) schedules 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 SLT and MLT schedules for the Business Account associated with the request access token.

Endpoint

GET /v2/scheduled-transactions

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

requestorId

string (UUID)

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

requestorType

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

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

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

createdDateFrom

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

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

createdDateTo

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

Date the SLT/MLT schedule was created in the RocketKOR system. This filter will return schedules 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 an IANA Time Zone Database region ID (example: the value for America/New_York is -04)

amountFrom

number

Transaction amount for the SLT/MLT schedule. This filter will return schedules with a transaction amount equal to or greater than this amount.

amountTo

number

Transaction amount for the SLT/MLT schedule. This filter will return schedules 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 SLT/MLT schedule.

creditFinancialAccountId

string (UUID)

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

status

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

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

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

name

string

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

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).

scheduleType

string enum, values: once-off, recurring

Type of SLT/MLT schedule. Possible values are:

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

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

SAMPLE RESPONSE

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "content": [
    {
      "createdBy": {
        "id": "ae88674e-8953-497c-b877-449bdedb6460",
        "type": "employee"
      },
      "createdAt": "2023-11-21T19:14:52.701Z",
      "updatedBy": {
        "id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
        "type": "employee"
      },
      "updatedAt": "2023-12-12T01:09:27.246Z",
      "startDateTime": "2023-12-01T10:15:30:00",
      "timeZone": "UTC",
      "calendarType": "BANKING",
      "recurrenceRule": "FREQ=DAILY;UNTIL=20231224T000000",
      "status": "ACTIVE",
      "name": "MLT-123",
      "transactionType": "MLT | SEND | REQUEST"
      "id": "d30e7743-73bc-487a-b999-afd3915c1aad",
      "scheduleType": "recurring",
      "schedulerId": "086ccefa-19ae-4a4b-b1be-d88aac965d53",
      "currency": "USD",
      "amount": 1000.00,
      "nextScheduledDate": "2023-12-21",
      "nextScheduledTime": "10:55",
      "remainingTransactions": 0,
      "metadata": {
        "rkorACHEntryType": "CCD",
        "myPaymentId": "100000333",
        "invoiceNumber": "123232333",
        "authorizedBy": "user@email.com"
      },
      "version": 1,
      "originatingChannel": "EXTERNAL",
      "debitFinancialAccounts": [
        {
          "name": "Checking",
          "category": "EXTERNAL",
          "type": "BANK",
          "subtype": "CHECKING",
          "bankAccount": {
            "bankName": "Citibank",
            "nameOnAccount": "Mark Strong"
          },
          "maskedAccountNumber": "******6790",
        }
      ],
      "creditFinancialAccounts": [
        {
          "name": "Checking",
          "category": "EXTERNAL",
          "accountHolderType": "CUSTOMER",
          "type": "BANK",
          "subtype": "CHECKING",
          "bankAccount": {
            "bankName": "Citibank",
            "nameOnAccount": "Jane Smith"
          },
          "maskedAccountNumber": "******4325",
        }
      ]
    },
    {...},
    {...}
  ]
}