Package com.stripe.param
Class RecipientUpdateParams
java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.RecipientUpdateParams
-
Nested Class Summary
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
Field Summary
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
A bank account to attach to the recipient.getCard()
A U.S.ID of the card to set as the recipient's new default for payouts.An arbitrary string which you can attach to aRecipient
object.getEmail()
The recipient's email address.Specifies which fields in the response should be expanded.Map of extra parameters for custom features not available in this client library.Set of key-value pairs that you can attach to an object.getName()
The recipient's full, legal name.getTaxId()
The recipient's tax ID, as a string.Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
Method Details
-
builder
-
getBankAccount
A bank account to attach to the recipient. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details, with the options described below. -
getCard
A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's debit card details, with the options described below. Passingcard
will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the card creation API. Whenever you attach a card to a recipient, Stripe will automatically validate the debit card. -
getDefaultCard
ID of the card to set as the recipient's new default for payouts. -
getDescription
An arbitrary string which you can attach to aRecipient
object. It is displayed alongside the recipient in the web interface. -
getEmail
The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking. -
getExpand
Specifies which fields in the response should be expanded. -
getExtraParams
Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's@SerializedName
value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance. -
getMetadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata
. -
getName
The recipient's full, legal name. For typeindividual
, should be in the formatFirst Last
,First Middle Last
, orFirst M Last
(no prefixes or suffixes). Forcorporation
, the full, incorporated name. -
getTaxId
The recipient's tax ID, as a string. For typeindividual
, the full SSN; for typecorporation
, the full EIN.
-