Update an MLT

Update a multi-leg transaction (MLT). A new version number will be assigned to the updated MLT.

An MLT can be updated before the DISBURSING stage begins. The following parameters can be updated:

credits.financialAccountId
credits.paymentReasonId
credits.amount
credits.solution
credits.settlementPriority

Once the DISBURSING stage begins, the MLT can only be cancelled.

Note The request must include the ETag value for the latest version of the MLT. This value can be retrieved using the Retrieve an MLT API.

Endpoint

PUT /v1/multi-leg-transactions/{mltId}

Authorization Header

Authorization: Bearer <access_token>

ETag Header

If-Match REQUIRED

string

The ETag (entity tag) header value for the latest version of the multi-leg-transaction. Use the Retrieve an MLT API to get the ETag value.

Path Parameters

mltId REQUIRED

string (UUID)

ID of the multi-leg transaction (MLT) in the RocketKOR system.

Request Body

credits

array

Credit transaction for the MLT disbursement leg. This transaction is used to disburse funds to the credit Financial Account.

financialAccountId

string (UUID)

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

paymentReasonId

string

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

solution

string

Name of the RocketKOR solution used for the transaction.

amount

string (decimal)

Transaction amount. The amount must conform to any transaction limits.

If the debit transaction includes amountPercentage, the credit transaction cannot include amount.
If provided, amount must be the same as the debit transaction amount.
Either amount or amountPercentage can be provided. The request will fail if both parameters are provided.
If the transaction is created using amountPercentage, the response amount will show the actual transaction value.

settlementPriority

string enum, values: IMMEDIATE, SAME_DAY, NEXT_DAY, SCHEDULED

Expected priority for settling the transaction. The following values are supported:

IMMEDIATE Near real-time.
SAME_DAY Same business day.
NEXT_DAY Next business day.
SCHEDULED Reserved for future use.

This parameter is configurable for some RocketKOR solutions, such as ACH and Wire.

Notes:

For MLT funding leg ACH transactions, the default value is SAME_DAY.
Push to Card transactions always use the IMMEDIATE settlement priority.
Wire transactions only allow the SAME_DAY and NEXT_DAY settlement priorities.

Returns

Returns an ETag (entity tag) header with an identifier that represents the current status of the resource. This identifier must be provided when updating the multi-leg transaction.

Returns the MLT object. This object contains the MLT details, including details for the individual debit and credit transactions.

SAMPLE REQUEST

				
					{
  "credits": [
    {
      "financialAccountId": "4c076ddc-0bf0-4c7c-a62d-079d7672cbec",
      "paymentReasonId": "funds_transfer",
      "settlementPriority": "SAME_DAY"
    }
  ]
}

SAMPLE RESPONSE

				
					{
  "currency": "USD",
  "totalAmount": "1200.00",
  "metadata": {
    "myPaymentId": "100000333",
    "invoiceNumber": "123232333",
    "authorizedBy": "user@email.com"
  },
  "name": "MLT-123",
  "description": "",
  "memo": "",
  "initiatorAccountHolderId": "ebfa3e16-63c4-48e3-ae59-a3194a867269",
  "originatingChannel": "EXTERNAL",
  "id": "9b4aff10-ad49-4f72-ae77-204a28f60196",
  "businessAccountId": "32edfac0-edbd-47f5-aff9-a030b1883cce",
  "stage": "FUNDING",
  "status": "PENDING",
  "debitAmountPending": "1200.00",
  "debitAmountCleared": "",
  "creditAmountPending": "1200.00",
  "creditAmountSettled": "",
  "debits": [
    {
      "sequence": 0,
      "financialAccountId": "89947c99-1ef5-4b30-ba9c-c1103196b0c9",
      "maskedAccountNumber": "******6790",
      "paymentReasonId": "funds_transfer",
      "amount": "1200.00",
      "amountPercentage": "",
      "settlementPriority": "SAME_DAY",
      "transactionId": "c0555c1a-0699-4ff4-aa9d-cd2724832be4",
      "solution": "ach",
      "latestStatus": {
        "status": "NEW",
        "message": "2023-12-11T01:09:27.246Z",
        "createdBy": {
          "id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
          "type": "employee"
        },
        "createdAt": "2023-12-11T01:09:27.246Z"
      },
      "_embedded": {
        "financialAccount": {
          "name": "Checking",
          "category": "EXTERNAL",
          "type": "BANK",
          "subtype": "CHECKING",
          "bankAccount": {
            "bankName": "Citibank",
            "nameOnAccount": "Bill Anderson"
          },
          "maskedAccountNumber": "******6790"
        }
      }
    }
  ],
  "credits": [
    {
      "sequence": 0,
      "financialAccountId": "4c076ddc-0bf0-4c7c-a62d-079d7672cbec",
      "maskedAccountNumber": "******4325",
      "paymentReasonId": "funds_transfer",
      "amount": "1200.00",
      "amountPercentage": "",
      "settlementPriority": "SAME_DAY",
      "transactionId": "f0e04c6d-d293-47a1-bdec-dc56ccef8de4",
      "solution": "ach",
      "latestStatus": {
        "status": "NEW",
        "message": "2023-12-11T01:09:27.246Z",
        "createdBy": {
          "id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
          "type": "employee"
        },
        "createdAt": "2023-12-11T01:09:27.246Z"
      },
      "_embedded": {
        "financialAccount": {
          "name": "Checking",
          "category": "EXTERNAL",
          "accountHolderType": "CUSTOMER",
          "type": "BANK",
          "subtype": "CHECKING",
          "bankAccount": {
            "bankName": "Citibank",
            "nameOnAccount": "Jane Smith"
          },
          "maskedAccountNumber": "******4325"
        },
        "accountHolderId": "64fff1fb-619e-4a07-80ad-ac484f2c1087"
      }
    }
  ],
  "createdBy": {
    "id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
    "type": "employee"
  },
  "createdAt": "2023-12-11T01:09:27.246Z",
  "updatedBy": {
    "id": "5618f9c9-bc6d-44cc-9eb8-abf76824592b",
    "type": "employee"
  },
  "updatedAt": "2023-12-12T01:09:27.246Z",
  "version": 1,
  "parentId": "01dc88fc-9e9a-47c0-b5c2-139d20356785"
}