You can edit a scheduled transaction before the start date (startDateTime). The scheduled transaction cannot be modified after the startDateTime has occurred.
You can edit details including the debit and credit Financial Accounts, transaction amount, payment reason, start date, and recurrence schedule. When you edit a transaction, the status of the original transaction is changed to CANCELLED and a new transaction is created.
This API is available for some RocketKOR solutions, such as ACH.
PUT /v1/scheduled-transactions/{scheduledTransactionId}
Authorization: Bearer <access_token>
Idempotency-Key: <key>
where <key> is a v4 UUID or any other unique string with a minimum length of 6 characters and a maximum length of 255 characters.
The idempotency key identifies the request. If a network error occurs, you can safely retry the request using the same idempotency key and the request will only be executed once. This ensures that calling the API multiple times will not result in duplicate requests. For more information, see Idempotent Calls.
scheduledTransactionId REQUIRED
string (UUID)
ID of the scheduled transaction in the RocketKOR system.
solution REQUIRED
string
Name of the RocketKOR solution used for the transaction.
debitFinancialAccountId REQUIRED
string (UUID)
ID of the Financial Account used as the debit account (source of the funds) for the transaction.
creditFinancialAccountId REQUIRED
string (UUID)
ID of the Financial Account used as the credit account (receiver of the funds) for the transaction.
transactionType REQUIRED
string enum, values: SEND, REQUEST
Type of transaction. The following values are supported:
amount CONDITIONAL
string (decimal)
Transaction amount. Must be a positive number. This amount will be transferred from the debit account to the credit account. The amount must conform to any transaction limits.
Either amount or debitBalancePercent is required. The request will fail if both parameters are provided.
debitBalancePercent CONDITIONAL
string (decimal)
Percentage of the debitFinancialAccountId balance to use as the transaction amount. Must be a positive number. This amount will be transferred from the debit account to the credit account. The amount must conform to any transaction limits.
Supports 4 decimal places. For example, to specify 12.25%, use the value 0.1225.
Either amount or debitBalancePercent is required. The request will fail if both parameters are provided.
paymentReasonId REQUIRED
string
ID representing the payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available payment reasons.
description
string, max length: 100
Only available for the Wire solution.
Brief description of the transaction. If the value exceeds the maximum length, the value will be truncated to 100 characters when the transaction is submitted for processing.
If this field is modified, the field will be updated in RocketKOR only. The changes will not be passed to the provider responsible for processing the transaction.
startDateTime REQUIRED
string (date-time)
Date and time to initiate the transaction. Must be provided in ISO 8601 format without the time zone designator. The date will be interpreted using the timeZone parameter, and UTC format will be used if timeZone is not provided.
For recurring transactions, this is the date and time when the recurrenceRule will take effect. For example, let’s say a request has the following parameters:
"startDateTime": "2023-08-31T12:00:00",
"recurrenceRule: "FREQ=WEEKLY;BYDAY=MO"
In this example, the start date is on a Thursday and the recurrence rule is weekly executions each Monday. Therefore the first transaction will be created on Monday, September 4th, at 12:00 pm in the specified time zone.
timeZone
string
Time zone for startDateTime. The following values are supported:
recurrenceRule
string
Rule used to schedule transactions on a recurring basis. Must be specified using the IETF iCalendar RFC 5545 RRULE property.
For example, let’s say a request has the following parameters:
"timeZone": "America/New_York",
"startDateTime": "1997-09-02T09:00:00",
"recurrenceRule": "FREQ=DAILY;UNTIL=19971224T000000"
This request will create transactions at the following times:
September 2, 1997 to October 25, 1997 (inclusive) at 9:00 AM EDT
October 26, 1997 to December 23, 1997 (inclusive) at 9:00 AM EST
name CONDITIONAL
string, max length: 60
Name of the scheduled transaction. Required if recurrenceRule is provided.
Returns the Scheduled Transaction object for the new transaction.
SAMPLE REQUEST
{
"recurrenceRule": "FREQ=DAILY;UNTIL=20231224T000000",
}
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"
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2023 RocketKOR, Inc. All rights reserved.
