Class TransactionSimulateClearingParams

  • All Implemented Interfaces:
    com.lithic.api.core.Params

    
    public final class TransactionSimulateClearingParams
     implements Params
                        

    Clears an existing authorization, either debit or credit. After this event, the transaction transitions from PENDING to SETTLED status.

    If amount is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.

    • Constructor Detail

    • Method Detail

      • token

         final String token()

        The transaction token returned from the /v1/simulate/authorize response.

      • amount

         final Optional<Long> amount()

        Amount (in cents) to clear. Typically this will match the amount in the original authorization, but can be higher or lower. The sign of this amount will automatically match the sign of the original authorization's amount. For example, entering 100 in this field will result in a -100 amount in the transaction, if the original authorization is a credit authorization.

        If amount is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.

      • _token

         final JsonField<String> _token()

        The transaction token returned from the /v1/simulate/authorize response.

      • _amount

         final JsonField<Long> _amount()

        Amount (in cents) to clear. Typically this will match the amount in the original authorization, but can be higher or lower. The sign of this amount will automatically match the sign of the original authorization's amount. For example, entering 100 in this field will result in a -100 amount in the transaction, if the original authorization is a credit authorization.

        If amount is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.

      • _headers

         Headers _headers()

        The full set of headers in the parameters, including both fixed and additional headers.

      • _queryParams

         QueryParams _queryParams()

        The full set of query params in the parameters, including both fixed and additional query params.