Class BookTransferCreateParams
-
- 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 classBookTransferCreateParams.BuilderA builder for BookTransferCreateParams.
public final classBookTransferCreateParams.Bodypublic final classBookTransferCreateParams.CategoryCategory of the book transfer
public final classBookTransferCreateParams.TypeType of book_transfer
-
Method Summary
Modifier and Type Method Description final Longamount()Amount to be transferred in the currency’s smallest unit (e.g., cents for USD). final BookTransferCreateParams.Categorycategory()Category of the book transfer final StringfromFinancialAccountToken()Globally unique identifier for the financial account or card that will send the funds. final Stringsubtype()The program specific subtype code for the specified category/type. final StringtoFinancialAccountToken()Globally unique identifier for the financial account or card that will receive the funds. final BookTransferCreateParams.Typetype()Type of book_transfer final Optional<String>token()Customer-provided token that will serve as an idempotency token. final Optional<String>memo()Optional descriptor for the transfer. final JsonField<Long>_amount()Returns the raw JSON value of amount. final JsonField<BookTransferCreateParams.Category>_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.Type>_type()Returns the raw JSON value of type. final JsonField<String>_token()Returns the raw JSON value of token. final JsonField<String>_memo()Returns the raw JSON value of memo. 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.BuildertoBuilder()final BookTransferCreateParams.Body_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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static BookTransferCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of BookTransferCreateParams. -
-
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.Category 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.
-
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.Type type()
Type of book_transfer
-
token
final Optional<String> token()
Customer-provided token that will serve as an idempotency token. This token will become the transaction token.
-
_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.Category> _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.Type> _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.
-
_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.
-
_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.Body _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.
-
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()
-
-
-
-