Package com.stripe.model

Class Source

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.APIResource

com.stripe.model.ExternalAccount

com.stripe.model.Source

All Implemented Interfaces:

HasId, HasSourceTypeData, MetadataStore<ExternalAccount>

public class Source
extends ExternalAccount
implements HasSourceTypeData

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
Source()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(java.lang.Object other)
static Source	create(java.util.Map<java.lang.String,java.lang.Object> params)	Create a source.
static Source	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Create a source.
DeletedExternalAccount	delete(RequestOptions options)	Source objects cannot be deleted.
Source	detach()	Detach a source.
Source	detach(java.util.Map<java.lang.String,java.lang.Object> params)	Detach a source.
Source	detach(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Detach a source.
boolean	equals(java.lang.Object o)
java.lang.Long	getAmount()
java.lang.String	getClientSecret()
SourceCodeVerificationFlow	getCodeVerification()
java.lang.Long	getCreated()
java.lang.String	getCurrency()
java.lang.String	getFlow()
java.lang.Boolean	getLivemode()
SourceOwner	getOwner()
SourceReceiverFlow	getReceiver()
SourceRedirectFlow	getRedirect()
java.lang.String	getSourceInstanceURL()
java.lang.String	getStatementDescriptor()
java.lang.String	getStatus()
java.lang.String	getType()
java.util.Map<java.lang.String,java.lang.String>	getTypeData()
java.lang.String	getUsage()
int	hashCode()
static Source	retrieve(java.lang.String id)	Retrieve a source.
static Source	retrieve(java.lang.String id, RequestOptions options)	Retrieve a source.
void	setAmount(java.lang.Long amount)
void	setClientSecret(java.lang.String clientSecret)
void	setCodeVerification(SourceCodeVerificationFlow codeVerification)
void	setCreated(java.lang.Long created)
void	setCurrency(java.lang.String currency)
void	setFlow(java.lang.String flow)
void	setLivemode(java.lang.Boolean livemode)
void	setOwner(SourceOwner owner)
void	setReceiver(SourceReceiverFlow receiver)
void	setRedirect(SourceRedirectFlow redirect)
void	setStatementDescriptor(java.lang.String statementDescriptor)
void	setStatus(java.lang.String status)
void	setType(java.lang.String type)
void	setTypeData(java.util.Map<java.lang.String,java.lang.String> typeData)
void	setUsage(java.lang.String usage)
SourceTransactionCollection	sourceTransactions(java.util.Map<java.lang.String,java.lang.Object> params)	Retrieve a source's transactions.
SourceTransactionCollection	sourceTransactions(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Retrieve a source's transactions.
Source	update(java.util.Map<java.lang.String,java.lang.Object> params)	Update a source.
Source	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Update a source.
Source	verify(java.util.Map<java.lang.String,java.lang.Object> params)	Verify a source.
Source	verify(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Verify a source.

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 com.stripe.model.ExternalAccount

delete, getAccount, getCustomer, getId, getInstanceURL, getMetadata, getObject, setAccount, setCustomer, setId, setMetadata, setObject

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

Source

public Source()

Method Detail

getSourceInstanceURL

public java.lang.String getSourceInstanceURL()
                                      throws InvalidRequestException

Throws:

InvalidRequestException

create

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

Create a source.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

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

Create a source.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

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

Source objects cannot be deleted. Calling this method will raise an InvalidRequestException. Call detach() to detach the source from a customer object.

Overrides:

delete in class ExternalAccount

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

detach

public Source detach()
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Detach a source.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

detach

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

Detach a source.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

detach

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

Detach a source.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

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

Retrieve a source.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

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

Retrieve a source.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

sourceTransactions

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

Retrieve a source's transactions.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

sourceTransactions

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

Retrieve a source's transactions.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

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

Update a source.

Specified by:

update in interface MetadataStore<ExternalAccount>

Overrides:

update in class ExternalAccount

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

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

Update a source.

Specified by:

update in interface MetadataStore<ExternalAccount>

Overrides:

update in class ExternalAccount

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

verify

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

Verify a source.

Overrides:

verify in class ExternalAccount

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

verify

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

Verify a source.

Overrides:

verify in class ExternalAccount

Parameters:

params - request parameters

options - request options

Returns:

the verified bank account

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getAmount

public java.lang.Long getAmount()

getClientSecret

public java.lang.String getClientSecret()

getCodeVerification

public SourceCodeVerificationFlow getCodeVerification()

getCreated

public java.lang.Long getCreated()

getCurrency

public java.lang.String getCurrency()

getFlow

public java.lang.String getFlow()

getLivemode

public java.lang.Boolean getLivemode()

getOwner

public SourceOwner getOwner()

getReceiver

public SourceReceiverFlow getReceiver()

getRedirect

public SourceRedirectFlow getRedirect()

getStatementDescriptor

public java.lang.String getStatementDescriptor()

getStatus

public java.lang.String getStatus()

getType

public java.lang.String getType()

getUsage

public java.lang.String getUsage()

setAmount

public void setAmount(java.lang.Long amount)

setClientSecret

public void setClientSecret(java.lang.String clientSecret)

setCodeVerification

public void setCodeVerification(SourceCodeVerificationFlow codeVerification)

setCreated

public void setCreated(java.lang.Long created)

setCurrency

public void setCurrency(java.lang.String currency)

setFlow

public void setFlow(java.lang.String flow)

setLivemode

public void setLivemode(java.lang.Boolean livemode)

setOwner

public void setOwner(SourceOwner owner)

setReceiver

public void setReceiver(SourceReceiverFlow receiver)

setRedirect

public void setRedirect(SourceRedirectFlow redirect)

setStatementDescriptor

public void setStatementDescriptor(java.lang.String statementDescriptor)

setStatus

public void setStatus(java.lang.String status)

setType

public void setType(java.lang.String type)

setUsage

public void setUsage(java.lang.String usage)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class ExternalAccount

canEqual

protected boolean canEqual(java.lang.Object other)

Overrides:

canEqual in class ExternalAccount

hashCode

public int hashCode()

Overrides:

hashCode in class ExternalAccount

getTypeData

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

Specified by:

getTypeData in interface HasSourceTypeData

setTypeData

public void setTypeData(java.util.Map<java.lang.String,java.lang.String> typeData)

Specified by:

setTypeData in interface HasSourceTypeData