@@ -23,8 +23,9 @@ import java.util.Optional
2323 * Clears an existing authorization, either debit or credit. After this event, the transaction
2424 * transitions from `PENDING` to `SETTLED` status.
2525 *
26- * If `amount` is not set, the full amount of the transaction will be cleared. Transactions that
27- * have already cleared, either partially or fully, cannot be cleared again using this endpoint.
26+ * If `amount` is not set, the full amount of the transaction will be cleared. This endpoint may be
27+ * called multiple times against the same authorization to simulate a multiple-completion scenario,
28+ * with each call creating a separate clearing event.
2829 */
2930class TransactionSimulateClearingParams
3031private constructor (
@@ -48,8 +49,9 @@ private constructor(
4849 * result in a -100 amount in the transaction, if the original authorization is a credit
4950 * authorization.
5051 *
51- * If `amount` is not set, the full amount of the transaction will be cleared. Transactions that
52- * have already cleared, either partially or fully, cannot be cleared again using this endpoint.
52+ * If `amount` is not set, the full amount of the transaction will be cleared. This endpoint may
53+ * be called multiple times against the same authorization to simulate a multiple-completion
54+ * scenario, with each call creating a separate clearing event.
5355 *
5456 * @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if the
5557 * server responded with an unexpected value).
@@ -138,9 +140,9 @@ private constructor(
138140 * field will result in a -100 amount in the transaction, if the original authorization is a
139141 * credit authorization.
140142 *
141- * If `amount` is not set, the full amount of the transaction will be cleared. Transactions
142- * that have already cleared, either partially or fully, cannot be cleared again using this
143- * endpoint .
143+ * If `amount` is not set, the full amount of the transaction will be cleared. This endpoint
144+ * may be called multiple times against the same authorization to simulate a
145+ * multiple-completion scenario, with each call creating a separate clearing event .
144146 */
145147 fun amount (amount : Long ) = apply { body.amount(amount) }
146148
@@ -324,9 +326,9 @@ private constructor(
324326 * field will result in a -100 amount in the transaction, if the original authorization is a
325327 * credit authorization.
326328 *
327- * If `amount` is not set, the full amount of the transaction will be cleared. Transactions
328- * that have already cleared, either partially or fully, cannot be cleared again using this
329- * endpoint .
329+ * If `amount` is not set, the full amount of the transaction will be cleared. This endpoint
330+ * may be called multiple times against the same authorization to simulate a
331+ * multiple-completion scenario, with each call creating a separate clearing event .
330332 *
331333 * @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if the
332334 * server responded with an unexpected value).
@@ -405,9 +407,9 @@ private constructor(
405407 * this field will result in a -100 amount in the transaction, if the original
406408 * authorization is a credit authorization.
407409 *
408- * If `amount` is not set, the full amount of the transaction will be cleared.
409- * Transactions that have already cleared, either partially or fully, cannot be cleared
410- * again using this endpoint .
410+ * If `amount` is not set, the full amount of the transaction will be cleared. This
411+ * endpoint may be called multiple times against the same authorization to simulate a
412+ * multiple-completion scenario, with each call creating a separate clearing event .
411413 */
412414 fun amount (amount : Long ) = amount(JsonField .of(amount))
413415
0 commit comments