Recipient (stripe-java 5.3.0 API)

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 and Description

Recipient()

Constructors
Constructor and Description
`Recipient()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static RecipientCollection`	`all(Map<String,Object> params)` Deprecated.
`static RecipientCollection`	`all(Map<String,Object> params, RequestOptions options)` Deprecated.
`static RecipientCollection`	`all(Map<String,Object> params, String apiKey)` Deprecated.
`static Recipient`	`create(Map<String,Object> params)`
`static Recipient`	`create(Map<String,Object> params, RequestOptions options)`
`static Recipient`	`create(Map<String,Object> params, String apiKey)` Deprecated.
`Card`	`createCard(Map<String,Object> params)`
`Card`	`createCard(Map<String,Object> params, RequestOptions options)`
`Card`	`createCard(Map<String,Object> params, String apiKey)` Deprecated.
`Card`	`createCard(String token)`
`Card`	`createCard(String token, RequestOptions options)`
`Card`	`createCard(String token, String apiKey)` Deprecated.
`DeletedRecipient`	`delete()`
`DeletedRecipient`	`delete(RequestOptions options)`
`DeletedRecipient`	`delete(String apiKey)` Deprecated.
`BankAccount`	`getActiveAccount()`
`RecipientCardCollection`	`getCards()`
`Long`	`getCreated()`
`String`	`getDefaultCard()`
`Card`	`getDefaultCardObject()`
`Boolean`	`getDeleted()`
`String`	`getDescription()`
`String`	`getEmail()`
`String`	`getId()`
`Boolean`	`getLivemode()`
`Map<String,String>`	`getMetadata()`
`String`	`getMigratedTo()`
`Account`	`getMigratedToObject()`
`String`	`getName()`
`String`	`getObject()`
`String`	`getType()`
`Boolean`	`getVerified()`
`static RecipientCollection`	`list(Map<String,Object> params)`
`static RecipientCollection`	`list(Map<String,Object> params, RequestOptions options)`
`static Recipient`	`retrieve(String id)`
`static Recipient`	`retrieve(String id, Map<String,Object> params, RequestOptions options)`
`static Recipient`	`retrieve(String id, RequestOptions options)`
`static Recipient`	`retrieve(String id, String apiKey)` Deprecated.
`void`	`setActiveAccount(BankAccount activeAccount)`
`void`	`setCreated(Long created)`
`void`	`setDefaultCard(String defaultCardID)`
`void`	`setDefaultCardObject(Card c)`
`void`	`setDescription(String description)`
`void`	`setEmail(String email)`
`void`	`setId(String id)`
`void`	`setLivemode(Boolean livemode)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setMigratedTo(String migratedToID)`
`void`	`setMigratedToObject(Account c)`
`void`	`setName(String name)`
`void`	`setObject(String object)`
`void`	`setType(String type)`
`void`	`setVerified(Boolean verified)`
`Recipient`	`update(Map<String,Object> params)`
`Recipient`	`update(Map<String,Object> params, RequestOptions options)`
`Recipient`	`update(Map<String,Object> params, String apiKey)` Deprecated.

Methods inherited from class com.stripe.net.APIResource
classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setExpandableFieldID, setStripeResponseGetter, singleClassURL, singleClassURL, urlEncode

Methods inherited from class com.stripe.model.StripeObject
equals, toJson, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- Recipient
```
public Recipient()
```

Method Detail

getId
```
public String getId()
```
Specified by:

getId in interface HasId

setId
```
public void setId(String id)
```

getObject
```
public String getObject()
```

setObject
```
public void setObject(String object)
```

getActiveAccount
```
public BankAccount getActiveAccount()
```

setActiveAccount

public void setActiveAccount(BankAccount activeAccount)

getCards

public RecipientCardCollection getCards()

getCreated
```
public Long getCreated()
```

setCreated
```
public void setCreated(Long created)
```

getDefaultCard
```
public String getDefaultCard()
```

setDefaultCard

public void setDefaultCard(String defaultCardID)

getDefaultCardObject
```
public Card getDefaultCardObject()
```

setDefaultCardObject

public void setDefaultCardObject(Card c)

getDeleted
```
public Boolean getDeleted()
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getEmail
```
public String getEmail()
```

setEmail
```
public void setEmail(String email)
```

getLivemode
```
public Boolean getLivemode()
```

setLivemode

public void setLivemode(Boolean livemode)

getMetadata
```
public Map<String,String> getMetadata()
```
Specified by:

getMetadata in interface MetadataStore<Recipient>

setMetadata

public void setMetadata(Map<String,String> metadata)

getMigratedTo
```
public String getMigratedTo()
```

setMigratedTo

public void setMigratedTo(String migratedToID)

getMigratedToObject
```
public Account getMigratedToObject()
```

setMigratedToObject

public void setMigratedToObject(Account c)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getVerified
```
public Boolean getVerified()
```

setVerified

public void setVerified(Boolean verified)

create

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

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

Specified by:: update in interface MetadataStore<Recipient>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

createCard

public Card createCard(String token)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

createCard

public Card createCard(Map<String,Object> params)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

createCard

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

createCard

public Card createCard(String token,
                       RequestOptions options)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

createCard

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

createCard

public Card createCard(Map<String,Object> params,
                       RequestOptions options)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

create

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

create

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

list

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

list

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

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

Specified by:: update in interface MetadataStore<Recipient>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

Class Recipient

Nested Class Summary

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

Field Summary

Fields inherited from class com.stripe.net.APIResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.APIResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

Recipient

Method Detail

getId

setId

getObject

setObject

getActiveAccount

setActiveAccount

getCards

getCreated

setCreated

getDefaultCard

setDefaultCard

getDefaultCardObject

setDefaultCardObject

getDeleted

getDescription

setDescription

getEmail

setEmail

getLivemode

setLivemode

getMetadata

setMetadata

getMigratedTo

setMigratedTo

getMigratedToObject

setMigratedToObject

getName

setName

getType

setType

getVerified

setVerified

create

retrieve

update

delete

createCard

createCard

createCard

createCard

createCard

createCard

create

create

retrieve

retrieve

retrieve

list

list

all

all

all

update

update

delete

delete