Class Recipient
- All Implemented Interfaces:
HasId
,MetadataStore<Recipient>
,StripeObjectInterface
-
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 -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
static Recipient
create
(RecipientCreateParams params) Creates a newRecipient
object and verifies the recipient’s identity.static Recipient
create
(RecipientCreateParams params, RequestOptions options) Creates a newRecipient
object and verifies the recipient’s identity.static Recipient
Creates a newRecipient
object and verifies the recipient’s identity.static Recipient
create
(Map<String, Object> params, RequestOptions options) Creates a newRecipient
object and verifies the recipient’s identity.delete()
Permanently deletes a recipient.delete
(RequestOptions options) Permanently deletes a recipient.Permanently deletes a recipient.delete
(Map<String, Object> params, RequestOptions options) Permanently deletes a recipient.boolean
Hash describing the current account on the recipient, if there is one.getCards()
Time at which the object was created.Get ID of expandabledefaultCard
object.Get expandeddefaultCard
.Always true for a deleted object.An arbitrary string attached to the object.getEmail()
getId()
Unique identifier for the object.Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.Set of key-value pairs that you can attach to an object.Get ID of expandablemigratedTo
object.Get expandedmigratedTo
.getName()
Full, legal name of the recipient.String representing the object's type.Get ID of expandablerolledBackFrom
object.Get expandedrolledBackFrom
.getType()
Type of the recipient, one ofindividual
orcorporation
.Whether the recipient has been verified.int
hashCode()
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 RecipientCollection
Returns a list of your recipients.static RecipientCollection
list
(Map<String, Object> params, RequestOptions options) Returns a list of your recipients.static Recipient
Retrieves the details of an existing recipient.static Recipient
retrieve
(String id, RequestOptions options) Retrieves the details of an existing recipient.static Recipient
retrieve
(String id, RecipientRetrieveParams params, RequestOptions options) Retrieves the details of an existing recipient.static Recipient
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
(Long created) Time at which the object was created.void
setDefaultCard
(String id) void
setDefaultCardObject
(Card expandableObject) void
setDeleted
(Boolean deleted) Always true for a deleted object.void
setDescription
(String description) An arbitrary string attached to the object.void
void
Unique identifier for the object.void
setLivemode
(Boolean livemode) Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMetadata
(Map<String, String> metadata) Set of key-value pairs that you can attach to an object.void
setMigratedTo
(String id) void
setMigratedToObject
(Account expandableObject) void
Full, legal name of the recipient.void
String representing the object's type.void
void
setRolledBackFromObject
(Account expandableObject) void
Type of the recipient, one ofindividual
orcorporation
.void
setVerified
(Boolean verified) Whether the recipient has been verified.update
(RecipientUpdateParams params) Updates the specified recipient by setting the values of the parameters passed.update
(RecipientUpdateParams params, RequestOptions options) Updates the specified recipient by setting the values of the parameters passed.Updates the specified recipient by setting the values of the parameters passed.update
(Map<String, Object> 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, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
Constructor Details
-
Recipient
public Recipient()
-
-
Method Details
-
getDefaultCard
Get ID of expandabledefaultCard
object. -
setDefaultCard
-
getDefaultCardObject
Get expandeddefaultCard
. -
setDefaultCardObject
-
getMigratedTo
Get ID of expandablemigratedTo
object. -
setMigratedTo
-
getMigratedToObject
Get expandedmigratedTo
. -
setMigratedToObject
-
getRolledBackFrom
Get ID of expandablerolledBackFrom
object. -
setRolledBackFrom
-
getRolledBackFromObject
Get expandedrolledBackFrom
. -
setRolledBackFromObject
-
list
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(Map<String, Object> params, RequestOptions options) throws StripeExceptionReturns a list of your recipients. The recipients are returned sorted by creation date, with the most recently created recipients appearing first.- Throws:
StripeException
-
list
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
Creates a newRecipient
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(Map<String, Object> params, RequestOptions options) throws StripeExceptionCreates a newRecipient
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
Creates a newRecipient
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 newRecipient
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
Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.- Throws:
StripeException
-
retrieve
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(String id, Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieves 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(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
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 interfaceMetadataStore<Recipient>
- Throws:
StripeException
-
update
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 interfaceMetadataStore<Recipient>
- Throws:
StripeException
-
update
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
Permanently deletes a recipient. It cannot be undone.- Throws:
StripeException
-
delete
Permanently deletes a recipient. It cannot be undone.- Throws:
StripeException
-
delete
Permanently deletes a recipient. It cannot be undone.- Throws:
StripeException
-
delete
Permanently deletes a recipient. It cannot be undone.- Throws:
StripeException
-
getActiveAccount
Hash describing the current account on the recipient, if there is one. -
getCards
-
getCreated
Time at which the object was created. Measured in seconds since the Unix epoch. -
getDeleted
Always true for a deleted object. -
getDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
getEmail
-
getLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
getName
Full, legal name of the recipient. -
getObject
String representing the object's type. Objects of the same type share the same value.Equal to
recipient
. -
getType
Type of the recipient, one ofindividual
orcorporation
. -
getVerified
Whether the recipient has been verified. This field is non-standard, and maybe removed in the future -
setActiveAccount
Hash describing the current account on the recipient, if there is one. -
setCards
-
setCreated
Time at which the object was created. Measured in seconds since the Unix epoch. -
setDeleted
Always true for a deleted object. -
setDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
setEmail
-
setId
Unique identifier for the object. -
setLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
setMetadata
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
Full, legal name of the recipient. -
setObject
String representing the object's type. Objects of the same type share the same value.Equal to
recipient
. -
setType
Type of the recipient, one ofindividual
orcorporation
. -
setVerified
Whether the recipient has been verified. This field is non-standard, and maybe removed in the future -
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the 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.- Specified by:
getMetadata
in interfaceMetadataStore<Recipient>
-