Package com.stripe.model

Class Recipient

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.APIResource

com.stripe.model.Recipient

All Implemented Interfaces:

HasId, MetadataStore<Recipient>

public class Recipient
extends APIResource
implements MetadataStore<Recipient>, HasId

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.APIResource

APIResource.RequestMethod, APIResource.RequestType

Field Summary

Fields inherited from class com.stripe.net.APIResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Recipient()

Method Summary

Modifier and Type	Method	Description
static RecipientCollection	all(java.util.Map<java.lang.String,java.lang.Object> params)	Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.
static RecipientCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
static RecipientCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)	Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
protected boolean	canEqual(java.lang.Object other)
static Recipient	create(java.util.Map<java.lang.String,java.lang.Object> params)	Create a recipient.
static Recipient	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Create a recipient.
static Recipient	create(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)	Deprecated. Use the create(Map, RequestOptions) method instead. This method will be removed in the next major version.
Card	createCard(java.lang.String token)	Deprecated. Use getCards() and RecipientCardCollection.create(Map) instead. This method will be removed in the next major version.
Card	createCard(java.lang.String token, RequestOptions options)	Deprecated. Use getCards() and RecipientCardCollection.create(Map, RequestOptions) instead. This method will be removed in the next major version.
Card	createCard(java.lang.String token, java.lang.String apiKey)	Deprecated. Use getCards() and RecipientCardCollection.create(Map, RequestOptions) instead. This method will be removed in the next major version.
Card	createCard(java.util.Map<java.lang.String,java.lang.Object> params)	Deprecated. Use getCards() and RecipientCardCollection.create(Map) instead. This method will be removed in the next major version.
Card	createCard(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Deprecated. Use getCards() and RecipientCardCollection.create(Map, RequestOptions) instead. This method will be removed in the next major version.
Card	createCard(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)	Deprecated. Use getCards() and RecipientCardCollection.create(Map, RequestOptions) instead. This method will be removed in the next major version.
DeletedRecipient	delete()	Delete a recipient.
DeletedRecipient	delete(RequestOptions options)	Delete a recipient.
DeletedRecipient	delete(java.lang.String apiKey)	Deprecated. Use the delete(RequestOptions) method instead. This method will be removed in the next major version.
boolean	equals(java.lang.Object o)
BankAccount	getActiveAccount()
RecipientCardCollection	getCards()
java.lang.Long	getCreated()
java.lang.String	getDefaultCard()
Card	getDefaultCardObject()
java.lang.Boolean	getDeleted()
java.lang.String	getDescription()
java.lang.String	getEmail()
java.lang.String	getId()
java.lang.Boolean	getLivemode()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getMigratedTo()
Account	getMigratedToObject()
java.lang.String	getName()
java.lang.String	getObject()
java.lang.String	getType()
java.lang.Boolean	getVerified()
int	hashCode()
static RecipientCollection	list(java.util.Map<java.lang.String,java.lang.Object> params)	List all recipients.
static RecipientCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	List all recipients.
static Recipient	retrieve(java.lang.String id)	Retrieve a recipient.
static Recipient	retrieve(java.lang.String id, RequestOptions options)	Retrieve a recipient.
static Recipient	retrieve(java.lang.String id, java.lang.String apiKey)	Deprecated. Use the retrieve(String, RequestOptions) method instead. This method will be removed in the next major version.
static Recipient	retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Retrieve a recipient.
void	setActiveAccount(BankAccount activeAccount)
void	setCards(RecipientCardCollection cards)
void	setCreated(java.lang.Long created)
void	setDefaultCard(java.lang.String defaultCardID)
void	setDefaultCardObject(Card c)
void	setDeleted(java.lang.Boolean deleted)
void	setDescription(java.lang.String description)
void	setEmail(java.lang.String email)
void	setId(java.lang.String id)
void	setLivemode(java.lang.Boolean livemode)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setMigratedTo(java.lang.String migratedToID)
void	setMigratedToObject(Account c)
void	setName(java.lang.String name)
void	setObject(java.lang.String object)
void	setType(java.lang.String type)
void	setVerified(java.lang.Boolean verified)
Recipient	update(java.util.Map<java.lang.String,java.lang.Object> params)	Update a recipient.
Recipient	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Update a recipient.
Recipient	update(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)	Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Methods inherited from class com.stripe.net.APIResource

classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setExpandableFieldID, setStripeResponseGetter, singleClassURL, singleClassURL, subresourceURL, urlEncode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Constructor Detail

Recipient

public Recipient()

Method Detail

getDefaultCard

public java.lang.String getDefaultCard()

setDefaultCard

public void setDefaultCard(java.lang.String defaultCardID)

getDefaultCardObject

public Card getDefaultCardObject()

setDefaultCardObject

public void setDefaultCardObject(Card c)

getMigratedTo

public java.lang.String getMigratedTo()

setMigratedTo

public void setMigratedTo(java.lang.String migratedToID)

getMigratedToObject

public Account getMigratedToObject()

setMigratedToObject

public void setMigratedToObject(Account c)

all

@Deprecated
public static RecipientCollection all(java.util.Map<java.lang.String,java.lang.Object> params)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.

List all recipients.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static RecipientCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                      RequestOptions options)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all recipients.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static RecipientCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                      java.lang.String apiKey)
                               throws AuthenticationException,
                                      InvalidRequestException,
                                      APIConnectionException,
                                      CardException,
                                      APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all recipients.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Recipient create(java.util.Map<java.lang.String,java.lang.Object> params)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Create a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Recipient create(java.util.Map<java.lang.String,java.lang.Object> params,
                               RequestOptions options)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Create a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

@Deprecated
public static Recipient create(java.util.Map<java.lang.String,java.lang.Object> params,
                               java.lang.String apiKey)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Deprecated. Use the create(Map, RequestOptions) method instead. This method will be removed in the next major version.

Create a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

createCard

@Deprecated
public Card createCard(java.lang.String token)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Deprecated. Use getCards() and RecipientCardCollection.create(Map) instead. This method will be removed in the next major version.

Create a card.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

createCard

@Deprecated
public Card createCard(java.lang.String token,
                       RequestOptions options)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Deprecated. Use getCards() and RecipientCardCollection.create(Map, RequestOptions) instead. This method will be removed in the next major version.

Create a card.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

createCard

@Deprecated
public Card createCard(java.lang.String token,
                       java.lang.String apiKey)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Deprecated. Use getCards() and RecipientCardCollection.create(Map, RequestOptions) instead. This method will be removed in the next major version.

Create a card.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

createCard

@Deprecated
public Card createCard(java.util.Map<java.lang.String,java.lang.Object> params)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Deprecated. Use getCards() and RecipientCardCollection.create(Map) instead. This method will be removed in the next major version.

Create a card.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

createCard

@Deprecated
public Card createCard(java.util.Map<java.lang.String,java.lang.Object> params,
                       RequestOptions options)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Deprecated. Use getCards() and RecipientCardCollection.create(Map, RequestOptions) instead. This method will be removed in the next major version.

Create a card.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

createCard

@Deprecated
public Card createCard(java.util.Map<java.lang.String,java.lang.Object> params,
                       java.lang.String apiKey)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Deprecated. Use getCards() and RecipientCardCollection.create(Map, RequestOptions) instead. This method will be removed in the next major version.

Create a card.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

public DeletedRecipient delete()
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Delete a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

public DeletedRecipient delete(RequestOptions options)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Delete a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

@Deprecated
public DeletedRecipient delete(java.lang.String apiKey)
                        throws AuthenticationException,
                               InvalidRequestException,
                               APIConnectionException,
                               CardException,
                               APIException

Deprecated. Use the delete(RequestOptions) method instead. This method will be removed in the next major version.

Delete a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static RecipientCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

List all recipients.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static RecipientCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                       RequestOptions options)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

List all recipients.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Recipient retrieve(java.lang.String id)
                          throws AuthenticationException,
                                 InvalidRequestException,
                                 APIConnectionException,
                                 CardException,
                                 APIException

Retrieve a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Recipient retrieve(java.lang.String id,
                                 RequestOptions options)
                          throws AuthenticationException,
                                 InvalidRequestException,
                                 APIConnectionException,
                                 CardException,
                                 APIException

Retrieve a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

@Deprecated
public static Recipient retrieve(java.lang.String id,
                                 java.lang.String apiKey)
                          throws AuthenticationException,
                                 InvalidRequestException,
                                 APIConnectionException,
                                 CardException,
                                 APIException

Deprecated. Use the retrieve(String, RequestOptions) method instead. This method will be removed in the next major version.

Retrieve a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Recipient retrieve(java.lang.String id,
                                 java.util.Map<java.lang.String,java.lang.Object> params,
                                 RequestOptions options)
                          throws AuthenticationException,
                                 InvalidRequestException,
                                 APIConnectionException,
                                 CardException,
                                 APIException

Retrieve a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Recipient update(java.util.Map<java.lang.String,java.lang.Object> params)
                 throws AuthenticationException,
                        InvalidRequestException,
                        APIConnectionException,
                        CardException,
                        APIException

Update a recipient.

Specified by:

update in interface MetadataStore<Recipient>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Recipient update(java.util.Map<java.lang.String,java.lang.Object> params,
                        RequestOptions options)
                 throws AuthenticationException,
                        InvalidRequestException,
                        APIConnectionException,
                        CardException,
                        APIException

Update a recipient.

Specified by:

update in interface MetadataStore<Recipient>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

@Deprecated
public Recipient update(java.util.Map<java.lang.String,java.lang.Object> params,
                        java.lang.String apiKey)
                 throws AuthenticationException,
                        InvalidRequestException,
                        APIConnectionException,
                        CardException,
                        APIException

Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Update a recipient.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getObject

public java.lang.String getObject()

getActiveAccount

public BankAccount getActiveAccount()

getCards

public RecipientCardCollection getCards()

getCreated

public java.lang.Long getCreated()

getDeleted

public java.lang.Boolean getDeleted()

getDescription

public java.lang.String getDescription()

getEmail

public java.lang.String getEmail()

getLivemode

public java.lang.Boolean getLivemode()

getName

public java.lang.String getName()

getType

public java.lang.String getType()

getVerified

public java.lang.Boolean getVerified()

setId

public void setId(java.lang.String id)

setObject

public void setObject(java.lang.String object)

setActiveAccount

public void setActiveAccount(BankAccount activeAccount)

setCards

public void setCards(RecipientCardCollection cards)

setCreated

public void setCreated(java.lang.Long created)

setDeleted

public void setDeleted(java.lang.Boolean deleted)

setDescription

public void setDescription(java.lang.String description)

setEmail

public void setEmail(java.lang.String email)

setLivemode

public void setLivemode(java.lang.Boolean livemode)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

setName

public void setName(java.lang.String name)

setType

public void setType(java.lang.String type)

setVerified

public void setVerified(java.lang.Boolean verified)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

Specified by:

getId in interface HasId

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Specified by:

getMetadata in interface MetadataStore<Recipient>