Recipient (stripe-java 18.10.0 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.ApiResource
  - - com.stripe.model.Recipient

All Implemented Interfaces:: HasId, MetadataStore<Recipient>, StripeObjectInterface

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

Nested Class Summary
- Nested classes/interfaces inherited from class com.stripe.net.ApiResource
  ApiResource.RequestMethod

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
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`static Recipient`	`create(java.util.Map<java.lang.String,java.lang.Object> params)` Creates a new `Recipient` object and verifies the recipient’s identity.
`static Recipient`	`create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Creates a new `Recipient` object and verifies the recipient’s identity.
`static Recipient`	`create(RecipientCreateParams params)` Creates a new `Recipient` object and verifies the recipient’s identity.
`static Recipient`	`create(RecipientCreateParams params, RequestOptions options)` Creates a new `Recipient` object and verifies the recipient’s identity.
`Recipient`	`delete()` Permanently deletes a recipient.
`Recipient`	`delete(java.util.Map<java.lang.String,java.lang.Object> params)` Permanently deletes a recipient.
`Recipient`	`delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Permanently deletes a recipient.
`Recipient`	`delete(RequestOptions options)` Permanently deletes a recipient.
`boolean`	`equals(java.lang.Object o)`
`BankAccount`	`getActiveAccount()` Hash describing the current account on the recipient, if there is one.
`CardCollection`	`getCards()`
`java.lang.Long`	`getCreated()` Time at which the object was created.
`java.lang.String`	`getDefaultCard()` Get ID of expandable `defaultCard` object.
`Card`	`getDefaultCardObject()` Get expanded `defaultCard`.
`java.lang.Boolean`	`getDeleted()` Always true for a deleted object.
`java.lang.String`	`getDescription()` An arbitrary string attached to the object.
`java.lang.String`	`getEmail()`
`java.lang.String`	`getId()` Unique identifier for the object.
`java.lang.Boolean`	`getLivemode()` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Set of key-value pairs that you can attach to an object.
`java.lang.String`	`getMigratedTo()` Get ID of expandable `migratedTo` object.
`Account`	`getMigratedToObject()` Get expanded `migratedTo`.
`java.lang.String`	`getName()` Full, legal name of the recipient.
`java.lang.String`	`getObject()` String representing the object's type.
`java.lang.String`	`getRolledBackFrom()` Get ID of expandable `rolledBackFrom` object.
`Account`	`getRolledBackFromObject()` Get expanded `rolledBackFrom`.
`java.lang.String`	`getType()` Type of the recipient, one of `individual` or `corporation`.
`java.lang.Boolean`	`getVerified()` Whether the recipient has been verified.
`int`	`hashCode()`
`static RecipientCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params)` Returns a list of your recipients.
`static RecipientCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Returns a list of your recipients.
`static RecipientCollection`	`list(RecipientListParams params)` Returns a list of your recipients.
`static RecipientCollection`	`list(RecipientListParams params, RequestOptions options)` Returns a list of your recipients.
`static Recipient`	`retrieve(java.lang.String id)` Retrieves the details of an existing recipient.
`static Recipient`	`retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Retrieves the details of an existing recipient.
`static Recipient`	`retrieve(java.lang.String id, RecipientRetrieveParams params, RequestOptions options)` Retrieves the details of an existing recipient.
`static Recipient`	`retrieve(java.lang.String id, RequestOptions options)` Retrieves the details of an existing recipient.
`void`	`setActiveAccount(BankAccount activeAccount)` Hash describing the current account on the recipient, if there is one.
`void`	`setCards(CardCollection cards)`
`void`	`setCreated(java.lang.Long created)` Time at which the object was created.
`void`	`setDefaultCard(java.lang.String id)`
`void`	`setDefaultCardObject(Card expandableObject)`
`void`	`setDeleted(java.lang.Boolean deleted)` Always true for a deleted object.
`void`	`setDescription(java.lang.String description)` An arbitrary string attached to the object.
`void`	`setEmail(java.lang.String email)`
`void`	`setId(java.lang.String id)` Unique identifier for the object.
`void`	`setLivemode(java.lang.Boolean livemode)` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)` Set of key-value pairs that you can attach to an object.
`void`	`setMigratedTo(java.lang.String id)`
`void`	`setMigratedToObject(Account expandableObject)`
`void`	`setName(java.lang.String name)` Full, legal name of the recipient.
`void`	`setObject(java.lang.String object)` String representing the object's type.
`void`	`setRolledBackFrom(java.lang.String id)`
`void`	`setRolledBackFromObject(Account expandableObject)`
`void`	`setType(java.lang.String type)` Type of the recipient, one of `individual` or `corporation`.
`void`	`setVerified(java.lang.Boolean verified)` Whether the recipient has been verified.
`Recipient`	`update(java.util.Map<java.lang.String,java.lang.Object> params)` Updates the specified recipient by setting the values of the parameters passed.
`Recipient`	`update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Updates the specified recipient by setting the values of the parameters passed.
`Recipient`	`update(RecipientUpdateParams params)` Updates the specified recipient by setting the values of the parameters passed.
`Recipient`	`update(RecipientUpdateParams params, RequestOptions options)` Updates the specified recipient by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

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

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

- Constructor Detail
  - Recipient
```
public Recipient()
```
- Method Detail
  - getDefaultCard
```
public java.lang.String getDefaultCard()
```
    Get ID of expandable defaultCard object.
  - setDefaultCard
```
public void setDefaultCard(java.lang.String id)
```
  - getDefaultCardObject
```
public Card getDefaultCardObject()
```
    Get expanded defaultCard.
  - setDefaultCardObject
```
public void setDefaultCardObject(Card expandableObject)
```
  - getMigratedTo
```
public java.lang.String getMigratedTo()
```
    Get ID of expandable migratedTo object.
  - setMigratedTo
```
public void setMigratedTo(java.lang.String id)
```
  - getMigratedToObject
```
public Account getMigratedToObject()
```
    Get expanded migratedTo.
  - setMigratedToObject
```
public void setMigratedToObject(Account expandableObject)
```
  - getRolledBackFrom
```
public java.lang.String getRolledBackFrom()
```
    Get ID of expandable rolledBackFrom object.
  - setRolledBackFrom
```
public void setRolledBackFrom(java.lang.String id)
```
  - getRolledBackFromObject
```
public Account getRolledBackFromObject()
```
    Get expanded rolledBackFrom.
  - setRolledBackFromObject
```
public void setRolledBackFromObject(Account expandableObject)
```
  - list
```
public static RecipientCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                                throws StripeException
```
    Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static RecipientCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                       RequestOptions options)
                                throws StripeException
```
    Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static RecipientCollection list(RecipientListParams params)
                                throws StripeException
```
    Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.
    
    Throws:
    
    StripeException
  - list
```
public static RecipientCollection list(RecipientListParams params,
                                       RequestOptions options)
                                throws StripeException
```
    Returns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.
    
    Throws:
    
    StripeException
  - create
```
public static Recipient create(java.util.Map<java.lang.String,java.lang.Object> params)
                        throws StripeException
```
    Creates a new Recipient object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.
    
    Throws:
    
    StripeException
  - create
```
public static Recipient create(java.util.Map<java.lang.String,java.lang.Object> params,
                               RequestOptions options)
                        throws StripeException
```
    Creates a new Recipient object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.
    
    Throws:
    
    StripeException
  - create
```
public static Recipient create(RecipientCreateParams params)
                        throws StripeException
```
    Creates a new Recipient object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.
    
    Throws:
    
    StripeException
  - create
```
public static Recipient create(RecipientCreateParams params,
                               RequestOptions options)
                        throws StripeException
```
    Creates a new Recipient object and verifies the recipient’s identity. Also verifies the recipient’s bank account information or debit card, if either is provided.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Recipient retrieve(java.lang.String id)
                          throws StripeException
```
    Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Recipient retrieve(java.lang.String id,
                                 RequestOptions options)
                          throws StripeException
```
    Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Recipient retrieve(java.lang.String id,
                                 java.util.Map<java.lang.String,java.lang.Object> params,
                                 RequestOptions options)
                          throws StripeException
```
    Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.
    
    Throws:
    
    StripeException
  - retrieve
```
public static Recipient retrieve(java.lang.String id,
                                 RecipientRetrieveParams params,
                                 RequestOptions options)
                          throws StripeException
```
    Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.
    
    Throws:
    
    StripeException
  - update
```
public Recipient update(java.util.Map<java.lang.String,java.lang.Object> params)
                 throws StripeException
```
    Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
    If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.
    
    Specified by:
    
    update in interface MetadataStore<Recipient>
    
    Throws:
    
    StripeException
  - update
```
public Recipient update(java.util.Map<java.lang.String,java.lang.Object> params,
                        RequestOptions options)
                 throws StripeException
```
    Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
    If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.
    
    Specified by:
    
    update in interface MetadataStore<Recipient>
    
    Throws:
    
    StripeException
  - update
```
public Recipient update(RecipientUpdateParams params)
                 throws StripeException
```
    Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
    If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.
    
    Throws:
    
    StripeException
  - update
```
public Recipient update(RecipientUpdateParams params,
                        RequestOptions options)
                 throws StripeException
```
    Updates the specified recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
    If you update the name or tax ID, the identity verification will automatically be rerun. If you update the bank account, the bank account validation will automatically be rerun.
    
    Throws:
    
    StripeException
  - delete
```
public Recipient delete()
                 throws StripeException
```
    Permanently deletes a recipient. It cannot be undone.
    
    Throws:
    
    StripeException
  - delete
```
public Recipient delete(RequestOptions options)
                 throws StripeException
```
    Permanently deletes a recipient. It cannot be undone.
    
    Throws:
    
    StripeException
  - delete
```
public Recipient delete(java.util.Map<java.lang.String,java.lang.Object> params)
                 throws StripeException
```
    Permanently deletes a recipient. It cannot be undone.
    
    Throws:
    
    StripeException
  - delete
```
public Recipient delete(java.util.Map<java.lang.String,java.lang.Object> params,
                        RequestOptions options)
                 throws StripeException
```
    Permanently deletes a recipient. It cannot be undone.
    
    Throws:
    
    StripeException
  - getActiveAccount
```
public BankAccount getActiveAccount()
```
    Hash describing the current account on the recipient, if there is one.
  - getCards
```
public CardCollection getCards()
```
  - getCreated
```
public java.lang.Long getCreated()
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - getDeleted
```
public java.lang.Boolean getDeleted()
```
    Always true for a deleted object.
  - getDescription
```
public java.lang.String getDescription()
```
    An arbitrary string attached to the object. Often useful for displaying to users.
  - getEmail
```
public java.lang.String getEmail()
```
  - getLivemode
```
public java.lang.Boolean getLivemode()
```
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  - getName
```
public java.lang.String getName()
```
    Full, legal name of the recipient.
  - getObject
```
public java.lang.String getObject()
```
    String representing the object's type. Objects of the same type share the same value.
    Equal to recipient.
  - getType
```
public java.lang.String getType()
```
    Type of the recipient, one of individual or corporation.
  - getVerified
```
public java.lang.Boolean getVerified()
```
    Whether the recipient has been verified. This field is non-standard, and maybe removed in the future
  - setActiveAccount
```
public void setActiveAccount(BankAccount activeAccount)
```
    Hash describing the current account on the recipient, if there is one.
  - setCards
```
public void setCards(CardCollection cards)
```
  - setCreated
```
public void setCreated(java.lang.Long created)
```
    Time at which the object was created. Measured in seconds since the Unix epoch.
  - setDeleted
```
public void setDeleted(java.lang.Boolean deleted)
```
    Always true for a deleted object.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    An arbitrary string attached to the object. Often useful for displaying to users.
  - setEmail
```
public void setEmail(java.lang.String email)
```
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier for the object.
  - setLivemode
```
public void setLivemode(java.lang.Boolean livemode)
```
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  - setMetadata
```
public void 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.
  - setName
```
public void setName(java.lang.String name)
```
    Full, legal name of the recipient.
  - setObject
```
public void setObject(java.lang.String object)
```
    String representing the object's type. Objects of the same type share the same value.
    Equal to recipient.
  - setType
```
public void setType(java.lang.String type)
```
    Type of the recipient, one of individual or corporation.
  - setVerified
```
public void setVerified(java.lang.Boolean verified)
```
    Whether the recipient has been verified. This field is non-standard, and maybe removed in the future
  - 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()
```
    Unique identifier for the object.
    
    Specified by:
    
    getId in interface HasId
  - getMetadata
```
public java.util.Map<java.lang.String,java.lang.String> 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.
    
    Specified by:
    
    getMetadata in interface MetadataStore<Recipient>

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

getDefaultCard

setDefaultCard

getDefaultCardObject

setDefaultCardObject

getMigratedTo

setMigratedTo

getMigratedToObject

setMigratedToObject

getRolledBackFrom

setRolledBackFrom

getRolledBackFromObject

setRolledBackFromObject

list

list

list

list

create

create

create

create

retrieve

retrieve

retrieve

retrieve

update

update

update

update

delete

delete

delete

delete

getActiveAccount

getCards

getCreated

getDeleted

getDescription

getEmail

getLivemode

getName

getObject

getType

getVerified

setActiveAccount

setCards

setCreated

setDeleted

setDescription

setEmail

setId

setLivemode

setMetadata

setName

setObject

setType

setVerified

equals

canEqual

hashCode

getId

getMetadata