All Implemented Interfaces:

com.lithic.api.core.Params
```
public final class BookTransferCreateParams
 implements Params
                    
```
Book transfer funds between two financial accounts or between a financial account and card

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BookTransferCreateParams.Builder`	A builder for BookTransferCreateParams.
`public final class`	`BookTransferCreateParams.CreateBookTransferRequest`
`public final class`	`BookTransferCreateParams.BookTransferCategory`	Category of the book transfer
`public final class`	`BookTransferCreateParams.BookTransferType`	Type of the book transfer
`public final class`	`BookTransferCreateParams.OnClosedAccount`	What to do if the financial account is closed when posting an operation

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 Long`	`amount()`	Amount to be transferred in the currency's smallest unit (e.g., cents for USD).
`final BookTransferCreateParams.BookTransferCategory`	`category()`	Category of the book transfer
`final String`	`fromFinancialAccountToken()`	Globally unique identifier for the financial account or card that will send the funds.
`final String`	`subtype()`	The program specific subtype code for the specified category/type.
`final String`	`toFinancialAccountToken()`	Globally unique identifier for the financial account or card that will receive the funds.
`final BookTransferCreateParams.BookTransferType`	`type()`	Type of the book transfer
`final Optional<String>`	`token()`	Customer-provided token that will serve as an idempotency token.
`final Optional<String>`	`externalId()`	External ID defined by the customer
`final Optional<String>`	`memo()`	Optional descriptor for the transfer.
`final Optional<BookTransferCreateParams.OnClosedAccount>`	`onClosedAccount()`	What to do if the financial account is closed when posting an operation
`final JsonField<Long>`	`_amount()`	Returns the raw JSON value of amount.
`final JsonField<BookTransferCreateParams.BookTransferCategory>`	`_category()`	Returns the raw JSON value of category.
`final JsonField<String>`	`_fromFinancialAccountToken()`	Returns the raw JSON value of fromFinancialAccountToken.
`final JsonField<String>`	`_subtype()`	Returns the raw JSON value of subtype.
`final JsonField<String>`	`_toFinancialAccountToken()`	Returns the raw JSON value of toFinancialAccountToken.
`final JsonField<BookTransferCreateParams.BookTransferType>`	`_type()`	Returns the raw JSON value of type.
`final JsonField<String>`	`_token()`	Returns the raw JSON value of token.
`final JsonField<String>`	`_externalId()`	Returns the raw JSON value of externalId.
`final JsonField<String>`	`_memo()`	Returns the raw JSON value of memo.
`final JsonField<BookTransferCreateParams.OnClosedAccount>`	`_onClosedAccount()`	Returns the raw JSON value of onClosedAccount.
`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 BookTransferCreateParams.Builder`	`toBuilder()`
`final BookTransferCreateParams.CreateBookTransferRequest`	`_body()`
`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 BookTransferCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BookTransferCreateParams.

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

- Constructor Detail
- Method Detail
  - amount
```
 final Long amount()
```
    Amount to be transferred in the currency's smallest unit (e.g., cents for USD). This should always be a positive value.
  - category
```
 final BookTransferCreateParams.BookTransferCategory category()
```
    Category of the book transfer
  - fromFinancialAccountToken
```
 final String fromFinancialAccountToken()
```
    Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case.
  - subtype
```
 final String subtype()
```
    The program specific subtype code for the specified category/type.
  - toFinancialAccountToken
```
 final String toFinancialAccountToken()
```
    Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program's use case.
  - type
```
 final BookTransferCreateParams.BookTransferType type()
```
    Type of the book transfer
  - token
```
 final Optional<String> token()
```
    Customer-provided token that will serve as an idempotency token. This token will become the transaction token.
  - externalId
```
 final Optional<String> externalId()
```
    External ID defined by the customer
  - memo
```
 final Optional<String> memo()
```
    Optional descriptor for the transfer.
  - onClosedAccount
```
 final Optional<BookTransferCreateParams.OnClosedAccount> onClosedAccount()
```
    What to do if the financial account is closed when posting an operation
  - _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.
  - _category
```
 final JsonField<BookTransferCreateParams.BookTransferCategory> _category()
```
    Returns the raw JSON value of category.
    Unlike category, this method doesn't throw if the JSON field has an unexpected type.
  - _fromFinancialAccountToken
```
 final JsonField<String> _fromFinancialAccountToken()
```
    Returns the raw JSON value of fromFinancialAccountToken.
    Unlike fromFinancialAccountToken, this method doesn't throw if the JSON field has an unexpected type.
  - _subtype
```
 final JsonField<String> _subtype()
```
    Returns the raw JSON value of subtype.
    Unlike subtype, this method doesn't throw if the JSON field has an unexpected type.
  - _toFinancialAccountToken
```
 final JsonField<String> _toFinancialAccountToken()
```
    Returns the raw JSON value of toFinancialAccountToken.
    Unlike toFinancialAccountToken, this method doesn't throw if the JSON field has an unexpected type.
  - _type
```
 final JsonField<BookTransferCreateParams.BookTransferType> _type()
```
    Returns the raw JSON value of type.
    Unlike type, 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.
  - _externalId
```
 final JsonField<String> _externalId()
```
    Returns the raw JSON value of externalId.
    Unlike externalId, 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.
  - _onClosedAccount
```
 final JsonField<BookTransferCreateParams.OnClosedAccount> _onClosedAccount()
```
    Returns the raw JSON value of onClosedAccount.
    Unlike onClosedAccount, 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 BookTransferCreateParams.Builder toBuilder()
```
  - _body
```
 final BookTransferCreateParams.CreateBookTransferRequest _body()
```
  - _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 BookTransferCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of BookTransferCreateParams.
    The following fields are required:
    .amount() .category() .fromFinancialAccountToken() .subtype() .toFinancialAccountToken() .type()

Class BookTransferCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

amount

category

fromFinancialAccountToken

subtype

toFinancialAccountToken

type

token

externalId

memo

onClosedAccount

_amount

_category

_fromFinancialAccountToken

_subtype

_toFinancialAccountToken

_type

_token

_externalId

_memo

_onClosedAccount

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder