All Implemented Interfaces:

com.lithic.api.core.Params
```
public final class HoldCreateParams
 implements Params
                    
```
Create a hold on a financial account. Holds reserve funds by moving them from available to pending balance. They can be resolved via settlement (linked to a payment or book transfer), voiding, or expiration.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`HoldCreateParams.Builder`	A builder for HoldCreateParams.
`public final class`	`HoldCreateParams.CreateHoldRequest`	Request to create a new hold on a financial account

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`financialAccountToken()`
`final Long`	`amount()`	Amount to hold in cents
`final Optional<String>`	`token()`	Customer-provided token for idempotency.
`final Optional<OffsetDateTime>`	`expirationDatetime()`	When the hold should auto-expire
`final Optional<String>`	`memo()`	Reason for the hold
`final Optional<String>`	`userDefinedId()`	User-provided identifier for the hold
`final JsonField<Long>`	`_amount()`	Returns the raw JSON value of amount.
`final JsonField<String>`	`_token()`	Returns the raw JSON value of token.
`final JsonField<OffsetDateTime>`	`_expirationDatetime()`	Returns the raw JSON value of expirationDatetime.
`final JsonField<String>`	`_memo()`	Returns the raw JSON value of memo.
`final JsonField<String>`	`_userDefinedId()`	Returns the raw JSON value of userDefinedId.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final HoldCreateParams.Builder`	`toBuilder()`
`final HoldCreateParams.CreateHoldRequest`	`_body()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static HoldCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of HoldCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - financialAccountToken
```
 final Optional<String> financialAccountToken()
```
  - amount
```
 final Long amount()
```
    Amount to hold in cents
  - token
```
 final Optional<String> token()
```
    Customer-provided token for idempotency. Becomes the hold token.
  - expirationDatetime
```
 final Optional<OffsetDateTime> expirationDatetime()
```
    When the hold should auto-expire
  - memo
```
 final Optional<String> memo()
```
    Reason for the hold
  - userDefinedId
```
 final Optional<String> userDefinedId()
```
    User-provided identifier for the hold
  - _amount
```
 final JsonField<Long> _amount()
```
    Returns the raw JSON value of amount.
    Unlike amount, this method doesn't throw if the JSON field has an unexpected type.
  - _token
```
 final JsonField<String> _token()
```
    Returns the raw JSON value of token.
    Unlike token, this method doesn't throw if the JSON field has an unexpected type.
  - _expirationDatetime
```
 final JsonField<OffsetDateTime> _expirationDatetime()
```
    Returns the raw JSON value of expirationDatetime.
    Unlike expirationDatetime, this method doesn't throw if the JSON field has an unexpected type.
  - _memo
```
 final JsonField<String> _memo()
```
    Returns the raw JSON value of memo.
    Unlike memo, this method doesn't throw if the JSON field has an unexpected type.
  - _userDefinedId
```
 final JsonField<String> _userDefinedId()
```
    Returns the raw JSON value of userDefinedId.
    Unlike userDefinedId, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final HoldCreateParams.Builder toBuilder()
```
  - _body
```
 final HoldCreateParams.CreateHoldRequest _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static HoldCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of HoldCreateParams.
    The following fields are required:
    .amount()

Class HoldCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

financialAccountToken

amount

token

expirationDatetime

memo

userDefinedId

_amount

_token

_expirationDatetime

_memo

_userDefinedId

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder