com.stripe.param

Class RecipientCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.RecipientCreateParams

public class RecipientCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecipientCreateParams.Builder

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 Type	Method and Description
static RecipientCreateParams.Builder	builder()
java.lang.String	getBankAccount() A bank account to attach to the recipient.
java.lang.String	getCard() A U.S.
java.lang.String	getDescription() An arbitrary string which you can attach to a Recipient object.
java.lang.String	getEmail() The recipient's email address.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.lang.Object	getMetadata() Set of key-value pairs that you can attach to an object.
java.lang.String	getName() The recipient's full, legal name.
java.lang.String	getTaxId() The recipient's tax ID, as a string.
java.lang.String	getType() Type of the recipient: either individual or corporation.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static RecipientCreateParams.Builder builder()

getBankAccount

public java.lang.String 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

public java.lang.String getCard()

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.

getDescription

public java.lang.String getDescription()

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

getEmail

public java.lang.String 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

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> 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

public java.lang.Object 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 to metadata.

getName

public java.lang.String getName()

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.

getTaxId

public java.lang.String getTaxId()

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

getType

public java.lang.String getType()

Type of the recipient: either individual or corporation.