Class CreateFundingWalletWithdrawalRequest
java.lang.Object
markets.alpaca.client.openapi.broker.model.CreateFundingWalletWithdrawalRequest
- All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.25.0")
public class CreateFundingWalletWithdrawalRequest
extends Object
implements Serializable
CreateFundingWalletWithdrawalRequest
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondesiredCurrency(String desiredCurrency) booleanfeeInclusive(Boolean feeInclusive) Create an instance of CreateFundingWalletWithdrawalRequest given an JSON stringReturn the additional (undeclared) property.Return the additional (undeclared) property with the specified name.Get desiredCurrencyWhen true, fees are deducted from `usd_amount` instead of being added on top, so the total amount debited from the account equals `usd_amount` exactly (the beneficiary receives `usd_amount` minus fees).Get paymentTypeGet usdAmountinthashCode()paymentType(FundingDetailPaymentType paymentType) putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.voidsetDesiredCurrency(String desiredCurrency) voidsetFeeInclusive(Boolean feeInclusive) voidsetPaymentType(FundingDetailPaymentType paymentType) voidsetUsdAmount(BigDecimal usdAmount) toJson()Convert an instance of CreateFundingWalletWithdrawalRequest to an JSON stringtoString()usdAmount(BigDecimal usdAmount) static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found
-
Field Details
-
SERIALIZED_NAME_DESIRED_CURRENCY
- See Also:
-
SERIALIZED_NAME_FEE_INCLUSIVE
- See Also:
-
SERIALIZED_NAME_PAYMENT_TYPE
- See Also:
-
SERIALIZED_NAME_USD_AMOUNT
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
CreateFundingWalletWithdrawalRequest
public CreateFundingWalletWithdrawalRequest()
-
-
Method Details
-
desiredCurrency
-
getDesiredCurrency
Get desiredCurrency- Returns:
- desiredCurrency
-
setDesiredCurrency
-
feeInclusive
-
getFeeInclusive
When true, fees are deducted from `usd_amount` instead of being added on top, so the total amount debited from the account equals `usd_amount` exactly (the beneficiary receives `usd_amount` minus fees). This lets the account be drained to zero: pass the account's full available cash as `usd_amount`. The request is rejected if `usd_amount` is less than or equal to the fees. Defaults to false (fees added on top of `usd_amount`).- Returns:
- feeInclusive
-
setFeeInclusive
-
paymentType
public CreateFundingWalletWithdrawalRequest paymentType(@Nullable FundingDetailPaymentType paymentType) -
getPaymentType
Get paymentType- Returns:
- paymentType
-
setPaymentType
-
usdAmount
-
getUsdAmount
Get usdAmount- Returns:
- usdAmount
-
setUsdAmount
-
putAdditionalProperty
Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.- Parameters:
key- name of the propertyvalue- value of the property- Returns:
- the CreateFundingWalletWithdrawalRequest instance itself
-
getAdditionalProperties
Return the additional (undeclared) property.- Returns:
- a map of objects
-
getAdditionalProperty
Return the additional (undeclared) property with the specified name.- Parameters:
key- name of the property- Returns:
- an object
-
equals
-
hashCode
public int hashCode() -
toString
-
validateJsonElement
Validates the JSON Element and throws an exception if issues found- Parameters:
jsonElement- JSON Element- Throws:
IOException- if the JSON Element is invalid with respect to CreateFundingWalletWithdrawalRequest
-
fromJson
Create an instance of CreateFundingWalletWithdrawalRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of CreateFundingWalletWithdrawalRequest
- Throws:
IOException- if the JSON string is invalid with respect to CreateFundingWalletWithdrawalRequest
-
toJson
Convert an instance of CreateFundingWalletWithdrawalRequest to an JSON string- Returns:
- JSON string
-