Retrieve a Transaction Schedule

Retrieve details for a single-leg transaction (SLT) schedule or a multi-leg transaction (MLT) schedule. The response includes information for the schedule (such as the ID, name, start date, recurrence rule, and status) and for the transaction(s) that will be created by the schedule (such as the Financial Accounts, currency, and transaction amount).

Endpoint

GET /v2/scheduled-transactions/{id}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

id REQUIRED

string (UUID)

ID of the SLT/MLT schedule.

Request Body

None

Returns

Returns the SLT Schedule Detail or MLT Schedule Detail object.

SAMPLE RESPONSE (SLT Schedule Object)

				
					{
  "createdBy": {
    "id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
    "type": "employee"
  },
  "createdAt": "2023-12-11T01:09:27.246Z",
  "updatedBy": {
    "id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
    "type": "employee"
  },
  "updatedAt": "2023-12-12T01:09:27.246Z",
  "startDateTime": "2023-12-01T10:15:30:00",
  "timeZone": "America/Toronto",
  "calendarType": "BANKING",
  "recurrenceRule": "FREQ=DAILY;UNTIL=20231224T000000",
  "name": "Loan Payment",
  "status": "ACTIVE",
  "id": "cc754cd5-292f-47e6-94f2-73319f979d53",
  "schedulerId": "ac2280c9-f42b-4a83-89d7-327e2f27e666",
  "maskedDebitAccountNumber": "******6790",
  "maskedCreditAccountNumber": "******2358",
  "originatingChannel": "EXTERNAL",
  "transactionSpec": {
    "metadata": {
      "rkorACHEntryType": "CCD",
      "myPaymentId": "100000333",
      "invoiceNumber": "123232333",
      "authorizedBy": "user@email.com"
    },
    "debitFinancialAccountId": "string(UUID)",
    "creditFinancialAccountId": "string(UUID)",
    "transactionType": "SEND",
    "solution": "ach",
    "paymentReasonId": "bill-payment",
    "amount": "1000.00",
    "debitBalancePercent": "",
    "currency": "USD",
    "settlementPriority": "SAME_DAY",
    "description": "",
    "memo": "",
    "initiatorAccountHolderId": "ebfa3e16-63c4-48e3-ae59-a3194a867269"
   }
}