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>

Path Parameters

transactionId REQUIRED

string (UUID)

Transaction ID in the RocketKOR system.

Request Body

debitFinancialAccountId REQUIRED

string (UUID)

ID for the Financial Account used as the debit account (source of the funds) for the transaction.

creditFinancialAccountId REQUIRED

string (UUID)

ID for the Financial Account used as the credit account (receiver of the funds) for the transaction.

amount REQUIRED

string

Amount to be transferred from the debit account to the credit account. Must be a positive number.

Note This amount must conform to any transaction limits.

paymentReasonId REQUIRED

string

Unique ID representing the payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available payment reasons.

Returns

Returns the new transaction. For details, see the Transaction object.

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",
    "createdAt": "2021-07-01T17:40:22.601Z"
  },
  "createdAt": "2021-07-01T17:40:22.601Z",
  "createdBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "EMPLOYEE"
  },
  "reversalReason": ""
}