Constructor Detail

Method Detail

• body

   final BookTransferCreateParams.Builder body(BookTransferCreateParams.CreateBookTransferRequest body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • amount

  • category

  • fromFinancialAccountToken

  • subtype

  • toFinancialAccountToken

  • etc.

• amount

   final BookTransferCreateParams.Builder amount(Long amount)

  Amount to be transferred in the currency's smallest unit (e.g., cents for USD). This should always be a positive value.

• amount

   final BookTransferCreateParams.Builder amount(JsonField<Long> amount)

  Sets Builder.amount to an arbitrary JSON value.

  You should usually call Builder.amount with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• category

   final BookTransferCreateParams.Builder category(BookTransferCreateParams.BookTransferCategory category)

  Category of the book transfer

• category

   final BookTransferCreateParams.Builder category(JsonField<BookTransferCreateParams.BookTransferCategory> category)

  Sets Builder.category to an arbitrary JSON value.

  You should usually call Builder.category with a well-typed BookTransferCategory value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• fromFinancialAccountToken

   final BookTransferCreateParams.Builder fromFinancialAccountToken(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.

• fromFinancialAccountToken

   final BookTransferCreateParams.Builder fromFinancialAccountToken(JsonField<String> fromFinancialAccountToken)

  Sets Builder.fromFinancialAccountToken to an arbitrary JSON value.

  You should usually call Builder.fromFinancialAccountToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• subtype

   final BookTransferCreateParams.Builder subtype(String subtype)

  The program specific subtype code for the specified category/type.

• subtype

   final BookTransferCreateParams.Builder subtype(JsonField<String> subtype)

  Sets Builder.subtype to an arbitrary JSON value.

  You should usually call Builder.subtype with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• toFinancialAccountToken

   final BookTransferCreateParams.Builder toFinancialAccountToken(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.

• toFinancialAccountToken

   final BookTransferCreateParams.Builder toFinancialAccountToken(JsonField<String> toFinancialAccountToken)

  Sets Builder.toFinancialAccountToken to an arbitrary JSON value.

  You should usually call Builder.toFinancialAccountToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• type

   final BookTransferCreateParams.Builder type(BookTransferCreateParams.BookTransferType type)

  Type of the book transfer

• type

   final BookTransferCreateParams.Builder type(JsonField<BookTransferCreateParams.BookTransferType> type)

  Sets Builder.type to an arbitrary JSON value.

  You should usually call Builder.type with a well-typed BookTransferType value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• token

   final BookTransferCreateParams.Builder token(String token)

  Customer-provided token that will serve as an idempotency token. This token will become the transaction token.

• token

   final BookTransferCreateParams.Builder token(JsonField<String> token)

  Sets Builder.token to an arbitrary JSON value.

  You should usually call Builder.token with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• externalId

   final BookTransferCreateParams.Builder externalId(String externalId)

  External ID defined by the customer

• externalId

   final BookTransferCreateParams.Builder externalId(JsonField<String> externalId)

  Sets Builder.externalId to an arbitrary JSON value.

  You should usually call Builder.externalId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• memo

   final BookTransferCreateParams.Builder memo(String memo)

  Optional descriptor for the transfer.

• memo

   final BookTransferCreateParams.Builder memo(JsonField<String> memo)

  Sets Builder.memo to an arbitrary JSON value.

  You should usually call Builder.memo with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• onClosedAccount

   final BookTransferCreateParams.Builder onClosedAccount(BookTransferCreateParams.OnClosedAccount onClosedAccount)

  What to do if the financial account is closed when posting an operation

• onClosedAccount

   final BookTransferCreateParams.Builder onClosedAccount(JsonField<BookTransferCreateParams.OnClosedAccount> onClosedAccount)

  Sets Builder.onClosedAccount to an arbitrary JSON value.

  You should usually call Builder.onClosedAccount with a well-typed OnClosedAccount value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final BookTransferCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final BookTransferCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final BookTransferCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final BookTransferCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final BookTransferCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final BookTransferCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final BookTransferCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final BookTransferCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final BookTransferCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final BookTransferCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final BookTransferCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final BookTransferCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final BookTransferCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final BookTransferCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final BookTransferCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final BookTransferCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final BookTransferCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final BookTransferCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final BookTransferCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final BookTransferCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final BookTransferCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final BookTransferCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final BookTransferCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final BookTransferCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final BookTransferCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final BookTransferCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final BookTransferCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final BookTransferCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final BookTransferCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final BookTransferCreateParams build()

  Returns an immutable instance of BookTransferCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .amount()
  .category()
  .fromFinancialAccountToken()
  .subtype()
  .toFinancialAccountToken()
  .type()