com.stripe.param

Class RecipientUpdateParams.Builder

java.lang.Object

com.stripe.param.RecipientUpdateParams.Builder

Enclosing class:

RecipientUpdateParams

public static class RecipientUpdateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RecipientUpdateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
RecipientUpdateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
RecipientUpdateParams	build() Finalize and obtain parameter instance from this builder.
RecipientUpdateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
RecipientUpdateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
RecipientUpdateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
RecipientUpdateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
RecipientUpdateParams.Builder	setBankAccount(java.lang.String bankAccount) A bank account to attach to the recipient.
RecipientUpdateParams.Builder	setCard(java.lang.String card) A U.S.
RecipientUpdateParams.Builder	setDefaultCard(java.lang.String defaultCard) ID of the card to set as the recipient's new default for payouts.
RecipientUpdateParams.Builder	setDescription(java.lang.String description) An arbitrary string which you can attach to a `Recipient` object.
RecipientUpdateParams.Builder	setEmail(java.lang.String email) The recipient's email address.
RecipientUpdateParams.Builder	setName(java.lang.String name) The recipient's full, legal name.
RecipientUpdateParams.Builder	setTaxId(java.lang.String taxId) The recipient's tax ID, as a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

build

public RecipientUpdateParams build()

Finalize and obtain parameter instance from this builder.

setBankAccount

public RecipientUpdateParams.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](https://stripe.com/docs/stripe-js), or a dictionary containing a user's bank account details, with the options described below.

setCard

public RecipientUpdateParams.Builder setCard(java.lang.String card)

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](https://stripe.com/docs/stripe-js), or a dictionary containing a user's debit card details, with the options described below. Passing `card` 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](#create_card). Whenever you attach a card to a recipient, Stripe will automatically validate the debit card.

setDefaultCard

public RecipientUpdateParams.Builder setDefaultCard(java.lang.String defaultCard)

ID of the card to set as the recipient's new default for payouts.

setDescription

public RecipientUpdateParams.Builder setDescription(java.lang.String description)

An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface.

setEmail

public RecipientUpdateParams.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 RecipientUpdateParams.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. See RecipientUpdateParams.expand for the field documentation.

addAllExpand

public RecipientUpdateParams.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. See RecipientUpdateParams.expand for the field documentation.

putExtraParam

public RecipientUpdateParams.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. See RecipientUpdateParams.extraParams for the field documentation.

putAllExtraParam

public RecipientUpdateParams.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. See RecipientUpdateParams.extraParams for the field documentation.

putMetadata

public RecipientUpdateParams.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. See RecipientUpdateParams.metadata for the field documentation.

putAllMetadata

public RecipientUpdateParams.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. See RecipientUpdateParams.metadata for the field documentation.

setName

public RecipientUpdateParams.Builder setName(java.lang.String name)

The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name.

setTaxId

public RecipientUpdateParams.Builder setTaxId(java.lang.String taxId)

The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN.