Retrieve a Scheduled Transaction

Retrieve details for a scheduled transaction, including the transaction details (Financial Accounts, amount, etc.) and the schedule details (start date, recurrence, etc.).

Endpoint

GET /v1/scheduled-transactions/{scheduledTransactionId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

scheduledTransactionId REQUIRED

string (UUID)

ID of the scheduled transaction in the RocketKOR system.

Request Body

None

Returns

Returns the Scheduled Transaction object. This object contains the scheduled transaction details, including a unique ID for the transaction.

SAMPLE RESPONSE

				
					{
  "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"
}