public class Source extends ApiResource implements MetadataStore<Source>, PaymentSource
Modifier and Type | Class and Description |
---|---|
static class |
Source.AchCreditTransfer |
static class |
Source.AchDebit |
static class |
Source.AcssDebit |
static class |
Source.Alipay |
static class |
Source.AuBecsDebit |
static class |
Source.Bancontact |
static class |
Source.Card |
static class |
Source.CardPresent |
static class |
Source.CodeVerificationFlow |
static class |
Source.Eps |
static class |
Source.Giropay |
static class |
Source.Ideal |
static class |
Source.Klarna |
static class |
Source.Multibanco |
static class |
Source.Order |
static class |
Source.OrderItem |
static class |
Source.Owner |
static class |
Source.P24 |
static class |
Source.ReceiverFlow |
static class |
Source.RedirectFlow |
static class |
Source.SepaCreditTransfer |
static class |
Source.SepaDebit |
static class |
Source.Sofort |
static class |
Source.ThreeDSecure |
static class |
Source.Wechat |
ApiResource.RequestMethod
CHARSET, GSON
PRETTY_PRINT_GSON
Constructor and Description |
---|
Source() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canEqual(java.lang.Object other) |
static Source |
create(java.util.Map<java.lang.String,java.lang.Object> params)
Creates a new source object.
|
static Source |
create(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Creates a new source object.
|
static Source |
create(SourceCreateParams params)
Creates a new source object.
|
static Source |
create(SourceCreateParams params,
RequestOptions options)
Creates a new source object.
|
Source |
detach()
Delete a specified source for a given customer.
|
Source |
detach(java.util.Map<java.lang.String,java.lang.Object> params)
Delete a specified source for a given customer.
|
Source |
detach(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Delete a specified source for a given customer.
|
Source |
detach(SourceDetachParams params)
Delete a specified source for a given customer.
|
Source |
detach(SourceDetachParams params,
RequestOptions options)
Delete a specified source for a given customer.
|
boolean |
equals(java.lang.Object o) |
Source.AchCreditTransfer |
getAchCreditTransfer() |
Source.AchDebit |
getAchDebit() |
Source.AcssDebit |
getAcssDebit() |
Source.Alipay |
getAlipay() |
java.lang.Long |
getAmount()
A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1,
Japanese Yen being a zero-decimal currency) representing the total amount associated with the
source.
|
Source.AuBecsDebit |
getAuBecsDebit() |
Source.Bancontact |
getBancontact() |
Source.Card |
getCard() |
Source.CardPresent |
getCardPresent() |
java.lang.String |
getClientSecret()
The client secret of the source.
|
Source.CodeVerificationFlow |
getCodeVerification() |
java.lang.Long |
getCreated()
Time at which the object was created.
|
java.lang.String |
getCurrency()
Three-letter ISO code for the currency
associated with the source.
|
java.lang.String |
getCustomer()
The ID of the customer to which this source is attached.
|
Source.Eps |
getEps() |
java.lang.String |
getFlow()
The authentication
flow of the source. |
Source.Giropay |
getGiropay() |
java.lang.String |
getId()
Unique identifier for the object.
|
Source.Ideal |
getIdeal() |
Source.Klarna |
getKlarna() |
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.
|
Source.Multibanco |
getMultibanco() |
java.lang.String |
getObject()
String representing the object's type.
|
Source.Owner |
getOwner()
Information about the owner of the payment instrument that may be used or required by
particular source types.
|
Source.P24 |
getP24() |
Source.ReceiverFlow |
getReceiver() |
Source.RedirectFlow |
getRedirect() |
Source.SepaCreditTransfer |
getSepaCreditTransfer() |
Source.SepaDebit |
getSepaDebit() |
Source.Sofort |
getSofort() |
Source.Order |
getSourceOrder() |
java.lang.String |
getStatementDescriptor()
Extra information about a source.
|
java.lang.String |
getStatus()
The status of the source, one of
canceled , chargeable , consumed , failed , or pending . |
Source.ThreeDSecure |
getThreeDSecure() |
java.lang.String |
getType()
The
type of the source. |
java.lang.String |
getUsage()
Either
reusable or single_use . |
Source.Wechat |
getWechat() |
int |
hashCode() |
static Source |
retrieve(java.lang.String source)
Retrieves an existing source object.
|
static Source |
retrieve(java.lang.String source,
java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Retrieves an existing source object.
|
static Source |
retrieve(java.lang.String source,
RequestOptions options)
Retrieves an existing source object.
|
static Source |
retrieve(java.lang.String source,
SourceRetrieveParams params,
RequestOptions options)
Retrieves an existing source object.
|
void |
setAchCreditTransfer(Source.AchCreditTransfer achCreditTransfer) |
void |
setAchDebit(Source.AchDebit achDebit) |
void |
setAcssDebit(Source.AcssDebit acssDebit) |
void |
setAlipay(Source.Alipay alipay) |
void |
setAmount(java.lang.Long amount)
A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1,
Japanese Yen being a zero-decimal currency) representing the total amount associated with the
source.
|
void |
setAuBecsDebit(Source.AuBecsDebit auBecsDebit) |
void |
setBancontact(Source.Bancontact bancontact) |
void |
setCard(Source.Card card) |
void |
setCardPresent(Source.CardPresent cardPresent) |
void |
setClientSecret(java.lang.String clientSecret)
The client secret of the source.
|
void |
setCodeVerification(Source.CodeVerificationFlow codeVerification) |
void |
setCreated(java.lang.Long created)
Time at which the object was created.
|
void |
setCurrency(java.lang.String currency)
Three-letter ISO code for the currency
associated with the source.
|
void |
setCustomer(java.lang.String customer)
The ID of the customer to which this source is attached.
|
void |
setEps(Source.Eps eps) |
void |
setFlow(java.lang.String flow)
The authentication
flow of the source. |
void |
setGiropay(Source.Giropay giropay) |
void |
setId(java.lang.String id)
Unique identifier for the object.
|
void |
setIdeal(Source.Ideal ideal) |
void |
setKlarna(Source.Klarna klarna) |
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 |
setMultibanco(Source.Multibanco multibanco) |
void |
setObject(java.lang.String object)
String representing the object's type.
|
void |
setOwner(Source.Owner owner)
Information about the owner of the payment instrument that may be used or required by
particular source types.
|
void |
setP24(Source.P24 p24) |
void |
setReceiver(Source.ReceiverFlow receiver) |
void |
setRedirect(Source.RedirectFlow redirect) |
void |
setSepaCreditTransfer(Source.SepaCreditTransfer sepaCreditTransfer) |
void |
setSepaDebit(Source.SepaDebit sepaDebit) |
void |
setSofort(Source.Sofort sofort) |
void |
setSourceOrder(Source.Order sourceOrder) |
void |
setStatementDescriptor(java.lang.String statementDescriptor)
Extra information about a source.
|
void |
setStatus(java.lang.String status)
The status of the source, one of
canceled , chargeable , consumed , failed , or pending . |
void |
setThreeDSecure(Source.ThreeDSecure threeDSecure) |
void |
setType(java.lang.String type)
The
type of the source. |
void |
setUsage(java.lang.String usage)
Either
reusable or single_use . |
void |
setWechat(Source.Wechat wechat) |
SourceTransactionCollection |
sourceTransactions()
List source transactions for a given source.
|
SourceTransactionCollection |
sourceTransactions(java.util.Map<java.lang.String,java.lang.Object> params)
List source transactions for a given source.
|
SourceTransactionCollection |
sourceTransactions(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
List source transactions for a given source.
|
SourceTransactionCollection |
sourceTransactions(SourceSourceTransactionsParams params)
List source transactions for a given source.
|
SourceTransactionCollection |
sourceTransactions(SourceSourceTransactionsParams params,
RequestOptions options)
List source transactions for a given source.
|
Source |
update(java.util.Map<java.lang.String,java.lang.Object> params)
Updates the specified source by setting the values of the parameters passed.
|
Source |
update(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Updates the specified source by setting the values of the parameters passed.
|
Source |
update(SourceUpdateParams params)
Updates the specified source by setting the values of the parameters passed.
|
Source |
update(SourceUpdateParams params,
RequestOptions options)
Updates the specified source by setting the values of the parameters passed.
|
Source |
verify(java.util.Map<java.lang.String,java.lang.Object> params)
Verify a given source.
|
Source |
verify(java.util.Map<java.lang.String,java.lang.Object> params,
RequestOptions options)
Verify a given source.
|
Source |
verify(SourceVerifyParams params)
Verify a given source.
|
Source |
verify(SourceVerifyParams params,
RequestOptions options)
Verify a given source.
|
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getLastResponse, setLastResponse
public Source detach() throws StripeException
StripeException
public Source detach(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public Source detach(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public Source detach(SourceDetachParams params) throws StripeException
StripeException
public Source detach(SourceDetachParams params, RequestOptions options) throws StripeException
StripeException
public static Source retrieve(java.lang.String source) throws StripeException
StripeException
public static Source retrieve(java.lang.String source, RequestOptions options) throws StripeException
StripeException
public static Source retrieve(java.lang.String source, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static Source retrieve(java.lang.String source, SourceRetrieveParams params, RequestOptions options) throws StripeException
StripeException
public static Source create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public static Source create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public static Source create(SourceCreateParams params) throws StripeException
StripeException
public static Source create(SourceCreateParams params, RequestOptions options) throws StripeException
StripeException
public Source update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
This request accepts the metadata
and owner
as arguments. It is
also possible to update type specific information for selected payment methods. Please refer to
our payment method guides for more detail.
update
in interface MetadataStore<Source>
StripeException
public Source update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
This request accepts the metadata
and owner
as arguments. It is
also possible to update type specific information for selected payment methods. Please refer to
our payment method guides for more detail.
update
in interface MetadataStore<Source>
StripeException
public Source update(SourceUpdateParams params) throws StripeException
This request accepts the metadata
and owner
as arguments. It is
also possible to update type specific information for selected payment methods. Please refer to
our payment method guides for more detail.
StripeException
public Source update(SourceUpdateParams params, RequestOptions options) throws StripeException
This request accepts the metadata
and owner
as arguments. It is
also possible to update type specific information for selected payment methods. Please refer to
our payment method guides for more detail.
StripeException
public Source verify(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public Source verify(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public Source verify(SourceVerifyParams params) throws StripeException
StripeException
public Source verify(SourceVerifyParams params, RequestOptions options) throws StripeException
StripeException
public SourceTransactionCollection sourceTransactions() throws StripeException
StripeException
public SourceTransactionCollection sourceTransactions(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
StripeException
public SourceTransactionCollection sourceTransactions(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
StripeException
public SourceTransactionCollection sourceTransactions(SourceSourceTransactionsParams params) throws StripeException
StripeException
public SourceTransactionCollection sourceTransactions(SourceSourceTransactionsParams params, RequestOptions options) throws StripeException
StripeException
public Source.AchCreditTransfer getAchCreditTransfer()
public Source.AchDebit getAchDebit()
public Source.AcssDebit getAcssDebit()
public Source.Alipay getAlipay()
public java.lang.Long getAmount()
single_use
sources.public Source.AuBecsDebit getAuBecsDebit()
public Source.Bancontact getBancontact()
public Source.Card getCard()
public Source.CardPresent getCardPresent()
public java.lang.String getClientSecret()
public Source.CodeVerificationFlow getCodeVerification()
public java.lang.Long getCreated()
public java.lang.String getCurrency()
single_use
sources.public java.lang.String getCustomer()
public Source.Eps getEps()
public java.lang.String getFlow()
flow
of the source. flow
is one of redirect
, receiver
, code_verification
, none
.public Source.Giropay getGiropay()
public Source.Ideal getIdeal()
public Source.Klarna getKlarna()
public java.lang.Boolean getLivemode()
true
if the object exists in live mode or the value false
if the
object exists in test mode.public Source.Multibanco getMultibanco()
public java.lang.String getObject()
Equal to source
.
public Source.Owner getOwner()
public Source.P24 getP24()
public Source.ReceiverFlow getReceiver()
public Source.RedirectFlow getRedirect()
public Source.SepaCreditTransfer getSepaCreditTransfer()
public Source.SepaDebit getSepaDebit()
public Source.Sofort getSofort()
public Source.Order getSourceOrder()
public java.lang.String getStatementDescriptor()
public java.lang.String getStatus()
canceled
, chargeable
, consumed
, failed
, or pending
. Only chargeable
sources can be used to create a charge.public Source.ThreeDSecure getThreeDSecure()
public java.lang.String getType()
type
of the source. The type
is a payment method, one of ach_credit_transfer
, ach_debit
, alipay
, bancontact
, card
,
card_present
, eps
, giropay
, ideal
, multibanco
, klarna
, p24
, sepa_debit
, sofort
, three_d_secure
, or wechat
. An additional hash is included on the source with a name matching this value. It
contains additional information specific to the payment method used.public java.lang.String getUsage()
reusable
or single_use
. Whether this source should be reusable or not.
Some source types may or may not be reusable by construction, while others may leave the option
at creation. If an incompatible value is passed, an error will be returned.public Source.Wechat getWechat()
public void setAchCreditTransfer(Source.AchCreditTransfer achCreditTransfer)
public void setAchDebit(Source.AchDebit achDebit)
public void setAcssDebit(Source.AcssDebit acssDebit)
public void setAlipay(Source.Alipay alipay)
public void setAmount(java.lang.Long amount)
single_use
sources.public void setAuBecsDebit(Source.AuBecsDebit auBecsDebit)
public void setBancontact(Source.Bancontact bancontact)
public void setCard(Source.Card card)
public void setCardPresent(Source.CardPresent cardPresent)
public void setClientSecret(java.lang.String clientSecret)
public void setCodeVerification(Source.CodeVerificationFlow codeVerification)
public void setCreated(java.lang.Long created)
public void setCurrency(java.lang.String currency)
single_use
sources.public void setCustomer(java.lang.String customer)
public void setEps(Source.Eps eps)
public void setFlow(java.lang.String flow)
flow
of the source. flow
is one of redirect
, receiver
, code_verification
, none
.public void setGiropay(Source.Giropay giropay)
public void setId(java.lang.String id)
public void setIdeal(Source.Ideal ideal)
public void setKlarna(Source.Klarna klarna)
public void setLivemode(java.lang.Boolean livemode)
true
if the object exists in live mode or the value false
if the
object exists in test mode.public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
public void setMultibanco(Source.Multibanco multibanco)
public void setObject(java.lang.String object)
Equal to source
.
public void setOwner(Source.Owner owner)
public void setP24(Source.P24 p24)
public void setReceiver(Source.ReceiverFlow receiver)
public void setRedirect(Source.RedirectFlow redirect)
public void setSepaCreditTransfer(Source.SepaCreditTransfer sepaCreditTransfer)
public void setSepaDebit(Source.SepaDebit sepaDebit)
public void setSofort(Source.Sofort sofort)
public void setSourceOrder(Source.Order sourceOrder)
public void setStatementDescriptor(java.lang.String statementDescriptor)
public void setStatus(java.lang.String status)
canceled
, chargeable
, consumed
, failed
, or pending
. Only chargeable
sources can be used to create a charge.public void setThreeDSecure(Source.ThreeDSecure threeDSecure)
public void setType(java.lang.String type)
type
of the source. The type
is a payment method, one of ach_credit_transfer
, ach_debit
, alipay
, bancontact
, card
,
card_present
, eps
, giropay
, ideal
, multibanco
, klarna
, p24
, sepa_debit
, sofort
, three_d_secure
, or wechat
. An additional hash is included on the source with a name matching this value. It
contains additional information specific to the payment method used.public void setUsage(java.lang.String usage)
reusable
or single_use
. Whether this source should be reusable or not.
Some source types may or may not be reusable by construction, while others may leave the option
at creation. If an incompatible value is passed, an error will be returned.public void setWechat(Source.Wechat wechat)
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected boolean canEqual(java.lang.Object other)
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String getId()
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
getMetadata
in interface MetadataStore<Source>