Search Scheduled Transactions

Search for scheduled transactions based on filters such as the requestor, solution, start 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 transactions for the Business Account associated with the request access token.

Endpoint

GET /v1/scheduled-transactions

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

requestorId

string (UUID)

ID of the entity that created the transaction.

requestorType

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

Type of entity that created the transaction. The following values are supported:

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

solution

string

Name of the RocketKOR solution used for the transaction.

startDateFrom

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

Start date of the scheduled transaction. This filter will return transactions created on or after this date.

Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.

startDateTo

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

Start date of the scheduled transaction. This filter will return transactions created on or before this date.

Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.

timeZone

string

Time zone for the startDateFrom and startDateTo 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)

transactionType

string enum, values: SEND, REQUEST

Type of transaction. The following values are supported:

SEND Push funds from a Financial Account to another Financial Account. Send transactions are originated on RocketKOR.
REQUEST Pull funds to a Financial Account from another Financial Account. Request transactions are originated on RocketKOR.

amountFrom

number

Amount of the transaction. This filter will return transactions with an amount equal to or greater than this amount.

amountTo

number

Amount of the transaction. This filter will return transactions 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 the funds) for the transaction.

creditFinancialAccountId

string (UUID)

ID of the Financial Account used as the credit account (receiver of the funds) for the transaction.

maskedDebitAccountNumber

string

Masked account number for the bank or card account used as the debit account for the transaction. Enter the last 4 digits of the account number (for example: 4242). Optionally, you can enter asterisks for the rest of the account number (for example: ********4242).

maskedCreditAccountNumber

string

Masked account number for the bank or card account used as the credit account for the transaction. Enter the last 4 digits of the account number (for example: 4242). Optionally, you can enter asterisks for the rest of the account number (for example: ********4242).

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

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

SAMPLE RESPONSE

				
					{
  "totalElements": 100,
  "totalPages": 20,
  "number": 0,
  "numberOfElements": 5,
  "hasNext": true,
  "content": [
    {
      "id": "cc754cd5-292f-47e6-94f2-73319f979d53",
      "status": "ACTIVE",
      "createdTransactionsCount": 0,
      "pendingTransactionsCount": 0,
      "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": "loan-payouts",
      "paymentReason": "Loan Payouts",
      "amount": "1000.00",
      "debitBalancePercent": "",
      "currency": "USD",
      "settlementPriority": "SAME_DAY",
      "createdAt": "2023-10-30T21:12:32.366Z",
      "requestor": {
        "id": "fd1c6009-a35c-4ddf-a4c8-dd946af7b647",
        "type": "service-account"
      },
      "description": "",
      "memo": "",
      "startDateTime": "2023-12-01T10:15:30:00",
      "timeZone": "America/Toronto",
      "recurrenceRule": "FREQ=DAILY;UNTIL=20231224T000000",
      "name": "Loan Payment"
    },
    {...},
    {...},
    {...},
    {...}
  ]
}