You can edit single-leg transaction (SLT) details including the debit and credit Financial Accounts, the transaction amount, and the payment reason ID. You can edit single-leg transactions that have a NEW or PENDING status. This API is available for some RocketKOR solutions, such as ACH.
When you edit a single-leg transaction, the status of the original transaction is changed to CANCELLED and a new transaction is created.
PUT /v1/transactions/{transactionId}
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.
transactionId REQUIRED
string (UUID)
ID of the single-leg transaction (SLT) in the RocketKOR system.
debitFinancialAccountId REQUIRED
string (UUID)
ID of the Financial Account used as the debit account (source of funds) for the transaction.
creditFinancialAccountId REQUIRED
string (UUID)
ID of the Financial Account used as the credit account (receiver of funds) for the transaction.
amount REQUIRED
string (decimal)
Transaction amount. The amount must conform to any transaction limits.
paymentReasonId REQUIRED
string
ID representing the payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available IDs.
Returns the SLT object for the new transaction.
SAMPLE REQUEST
{
"debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"amount": "1000.00",
"paymentReasonId": "bill-payment"
}
SAMPLE RESPONSE
{
"businessAccountId": "de30132c-e67a-4af7-89ec-f2109863b7f7",
"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": "bill-payment",
"paymentReason": "Bill payment",
"amount": "1000.00",
"currency": "USD",
"settlementPriority": "SAME_DAY",
"createdAt": "2021-07-01T17:40:22.601Z",
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"description": "",
"memo": "",
"initiatorAccountHolderId": "ebfa3e16-63c4-48e3-ae59-a3194a867269",
"externalTransactionInitiatorId": "c62d1e6b-39ce-496e-bf6d-8a019d2f534e",
"originatingChannel": "EXTERNAL",
"id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
"latestStatus": {
"status": "NEW",
"message": "Transaction creation successful",
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-01T17:40:22.601Z"
},
"reversalReason": ""
}
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
@ 2024 RocketKOR, Inc. All rights reserved.