Package com.stripe.param
Class RecipientCreateParams.Builder
- java.lang.Object
-
- com.stripe.param.RecipientCreateParams.Builder
-
- Enclosing class:
- RecipientCreateParams
public static class RecipientCreateParams.Builder extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RecipientCreateParams.Builder
addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list.RecipientCreateParams.Builder
addExpand(java.lang.String element)
Add an element to `expand` list.RecipientCreateParams
build()
Finalize and obtain parameter instance from this builder.RecipientCreateParams.Builder
putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map.RecipientCreateParams.Builder
putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
Add all map key/value pairs to `metadata` map.RecipientCreateParams.Builder
putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map.RecipientCreateParams.Builder
putMetadata(java.lang.String key, java.lang.String value)
Add a key/value pair to `metadata` map.RecipientCreateParams.Builder
setBankAccount(java.lang.String bankAccount)
A bank account to attach to the recipient.RecipientCreateParams.Builder
setCard(java.lang.String card)
A U.S.RecipientCreateParams.Builder
setDescription(java.lang.String description)
An arbitrary string which you can attach to aRecipient
object.RecipientCreateParams.Builder
setEmail(java.lang.String email)
The recipient's email address.RecipientCreateParams.Builder
setMetadata(EmptyParam metadata)
Set of key-value pairs that you can attach to an object.RecipientCreateParams.Builder
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.RecipientCreateParams.Builder
setName(java.lang.String name)
The recipient's full, legal name.RecipientCreateParams.Builder
setTaxId(java.lang.String taxId)
The recipient's tax ID, as a string.RecipientCreateParams.Builder
setType(java.lang.String type)
Type of the recipient: eitherindividual
orcorporation
.
-
-
-
Method Detail
-
build
public RecipientCreateParams build()
Finalize and obtain parameter instance from this builder.
-
setBankAccount
public RecipientCreateParams.Builder setBankAccount(java.lang.String bankAccount)
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.
-
setCard
public RecipientCreateParams.Builder setCard(java.lang.String card)
A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. 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. Although not all information is required, the extra info helps prevent fraud.
-
setDescription
public RecipientCreateParams.Builder setDescription(java.lang.String description)
An arbitrary string which you can attach to aRecipient
object. It is displayed alongside the recipient in the web interface.
-
setEmail
public RecipientCreateParams.Builder setEmail(java.lang.String email)
The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking.
-
addExpand
public RecipientCreateParams.Builder addExpand(java.lang.String element)
Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeRecipientCreateParams.expand
for the field documentation.
-
addAllExpand
public RecipientCreateParams.Builder addAllExpand(java.util.List<java.lang.String> elements)
Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. SeeRecipientCreateParams.expand
for the field documentation.
-
putExtraParam
public RecipientCreateParams.Builder putExtraParam(java.lang.String key, java.lang.Object value)
Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeRecipientCreateParams.extraParams
for the field documentation.
-
putAllExtraParam
public RecipientCreateParams.Builder putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map)
Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeRecipientCreateParams.extraParams
for the field documentation.
-
putMetadata
public RecipientCreateParams.Builder putMetadata(java.lang.String key, java.lang.String value)
Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeRecipientCreateParams.metadata
for the field documentation.
-
putAllMetadata
public RecipientCreateParams.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map)
Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeRecipientCreateParams.metadata
for the field documentation.
-
setMetadata
public RecipientCreateParams.Builder setMetadata(EmptyParam metadata)
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
.
-
setMetadata
public RecipientCreateParams.Builder setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
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
.
-
setName
public RecipientCreateParams.Builder setName(java.lang.String name)
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.
-
setTaxId
public RecipientCreateParams.Builder setTaxId(java.lang.String taxId)
The recipient's tax ID, as a string. For typeindividual
, the full SSN; for typecorporation
, the full EIN.
-
setType
public RecipientCreateParams.Builder setType(java.lang.String type)
Type of the recipient: eitherindividual
orcorporation
.
-
-