Edit a Transaction

Edit transaction details including the debit and credit Financial Accounts, the transaction amount, and the payment reason. You can edit transactions that have a NEW or PENDING status. This API is available for some RocketKOR solutions, such as ACH.

When you edit a transaction, the status of the original transaction is changed to CANCELLED and a new transaction is created.

Endpoint

PUT /v1/transactions/{transactionId}

Authorization Header

Authorization: Bearer <access_token>

Idempotency-Key Header

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.

Path Parameters

transactionId REQUIRED

string (UUID)

ID of the transaction in the RocketKOR system.

Request Body

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.

amount REQUIRED

string (currency)

Amount to be transferred from the debit account to the credit account. Must be a positive number. 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 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.

memo

string, max length: 100

Only available for the Wire solution. Brief additional note about 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.

Returns

Returns the Transaction object for the new transaction.

SAMPLE REQUEST

				
					{
  "debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "amount": "1000.00",
  "paymentReasonId": "loan-payouts"
}

SAMPLE RESPONSE

				
					{
  "id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
  "businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
  "metadata": {
    "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",
  "currency": "USD",
  "settlementPriority": "SAME_DAY",
  "latestStatus": {
    "status": "NEW",
    "message": "Transaction creation successful",
    "createdBy": {
      "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
      "type": "service-account"
    },
    "createdAt": "2021-07-01T17:40:22.601Z"
  },
  "createdBy": {
    "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
    "type": "service-account"
  },
  "createdAt": "2021-07-01T17:40:22.601Z",
  "reversalReason": "",
  "description": "",
  "memo": ""
}