Package com.stripe.model

Class Charge

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.Charge

All Implemented Interfaces:

HasId, MetadataStore<Charge>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Charge.AlternateStatementDescriptors
static class	Charge.FraudDetails
static class	Charge.Level3
static class	Charge.Outcome
static class	Charge.PaymentMethodDetails
static class	Charge.TransferData

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

ApiResource.RequestMethod, ApiResource.RequestType

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FRAUD_DETAILS

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(java.lang.Object other)
Charge	capture()	Capture a charge.
Charge	capture(RequestOptions options)	Capture a charge.
Charge	capture(java.util.Map<java.lang.String,java.lang.Object> params)	Capture a charge.
Charge	capture(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Capture a charge.
static Charge	create(java.util.Map<java.lang.String,java.lang.Object> params)	Create a charge.
static Charge	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Create a charge.
boolean	equals(java.lang.Object o)
Charge.AlternateStatementDescriptors	getAlternateStatementDescriptors()
java.lang.Long	getAmount()
java.lang.Long	getAmountRefunded()
java.lang.String	getApplication()
java.lang.String	getApplicationFee()
java.lang.Long	getApplicationFeeAmount()
ApplicationFee	getApplicationFeeObject()
Application	getApplicationObject()
java.lang.String	getAuthorizationCode()
java.lang.String	getBalanceTransaction()
BalanceTransaction	getBalanceTransactionObject()
PaymentMethod.BillingDetails	getBillingDetails()
java.lang.Boolean	getCaptured()
Card	getCard()	Deprecated. Prefer using the source attribute instead.
java.lang.Long	getCreated()
java.lang.String	getCurrency()
java.lang.String	getCustomer()
Customer	getCustomerObject()
java.lang.String	getDescription()
java.lang.String	getDestination()
Account	getDestinationObject()
java.lang.String	getDispute()
java.lang.Boolean	getDisputed()	Deprecated. Prefer using the dispute attribute instead.
Dispute	getDisputeObject()
java.lang.String	getFailureCode()
java.lang.String	getFailureMessage()
Charge.FraudDetails	getFraudDetails()
java.lang.String	getId()
java.lang.String	getInvoice()
Invoice	getInvoiceObject()
Charge.Level3	getLevel3()
java.lang.Boolean	getLivemode()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getObject()
java.lang.String	getOnBehalfOf()
Account	getOnBehalfOfObject()
java.lang.String	getOrder()
Order	getOrderObject()
Charge.Outcome	getOutcome()
java.lang.Boolean	getPaid()
java.lang.String	getPaymentIntent()
java.lang.String	getPaymentMethod()
Charge.PaymentMethodDetails	getPaymentMethodDetails()
java.lang.String	getReceiptEmail()
java.lang.String	getReceiptNumber()
java.lang.String	getReceiptUrl()
java.lang.Boolean	getRefunded()
ChargeRefundCollection	getRefunds()	Returns the refunds list.
java.lang.String	getReview()
Review	getReviewObject()
ShippingDetails	getShipping()
ExternalAccount	getSource()
java.lang.String	getSourceTransfer()
Transfer	getSourceTransferObject()
java.lang.String	getStatementDescription()	Deprecated. Prefer using the statementDescriptor attribute instead.
java.lang.String	getStatementDescriptor()
java.lang.String	getStatus()
java.lang.String	getTransfer()
Charge.TransferData	getTransferData()
java.lang.String	getTransferGroup()
Transfer	getTransferObject()
int	hashCode()
static ChargeCollection	list(java.util.Map<java.lang.String,java.lang.Object> params)	List all charges.
static ChargeCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	List all charges.
Charge	markFraudulent(RequestOptions options)	Mark the charge as fraudulent.
Charge	markSafe(RequestOptions options)	Mark the charge as safe.
Charge	refund()	Deprecated. Prefer using the Refund.create(Map) method instead.
Charge	refund(RequestOptions options)	Deprecated. Prefer using the Refund.create(Map, RequestOptions) method instead.
Charge	refund(java.util.Map<java.lang.String,java.lang.Object> params)	Deprecated. Prefer using the Refund.create(Map) method instead.
Charge	refund(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Deprecated. Prefer using the Refund.create(Map, RequestOptions) method instead.
static Charge	retrieve(java.lang.String id)	Retrieve a charge.
static Charge	retrieve(java.lang.String id, RequestOptions options)	Retrieve a charge.
static Charge	retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Retrieve a charge.
void	setAlternateStatementDescriptors(Charge.AlternateStatementDescriptors alternateStatementDescriptors)
void	setAmount(java.lang.Long amount)
void	setAmountRefunded(java.lang.Long amountRefunded)
void	setApplication(java.lang.String applicationId)
void	setApplicationFee(java.lang.String applicationFeeId)
void	setApplicationFeeAmount(java.lang.Long applicationFeeAmount)
void	setApplicationFeeObject(ApplicationFee c)
void	setApplicationObject(Application c)
void	setAuthorizationCode(java.lang.String authorizationCode)
void	setBalanceTransaction(java.lang.String balanceTransactionId)
void	setBalanceTransactionObject(BalanceTransaction c)
void	setBillingDetails(PaymentMethod.BillingDetails billingDetails)
void	setCaptured(java.lang.Boolean captured)
void	setCard(Card card)	Deprecated. Prefer using the source attribute instead.
void	setCreated(java.lang.Long created)
void	setCurrency(java.lang.String currency)
void	setCustomer(java.lang.String customerId)
void	setCustomerObject(Customer c)
void	setDescription(java.lang.String description)
void	setDestination(java.lang.String destinationId)
void	setDestinationObject(Account c)
void	setDispute(java.lang.String disputeId)
void	setDisputed(java.lang.Boolean disputed)	Deprecated. Prefer using the dispute attribute instead.
void	setDisputeObject(Dispute dispute)
void	setFailureCode(java.lang.String failureCode)
void	setFailureMessage(java.lang.String failureMessage)
void	setFraudDetails(Charge.FraudDetails fraudDetails)
void	setId(java.lang.String id)
void	setInvoice(java.lang.String invoiceId)
void	setInvoiceObject(Invoice c)
void	setLevel3(Charge.Level3 level3)
void	setLivemode(java.lang.Boolean livemode)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setObject(java.lang.String object)
void	setOnBehalfOf(java.lang.String onBehalfOfId)
void	setOnBehalfOfObject(Account c)
void	setOrder(java.lang.String orderId)
void	setOrderObject(Order c)
void	setOutcome(Charge.Outcome outcome)
void	setPaid(java.lang.Boolean paid)
void	setPaymentIntent(java.lang.String paymentIntent)
void	setPaymentMethod(java.lang.String paymentMethod)
void	setPaymentMethodDetails(Charge.PaymentMethodDetails paymentMethodDetails)
void	setReceiptEmail(java.lang.String receiptEmail)
void	setReceiptNumber(java.lang.String receiptNumber)
void	setReceiptUrl(java.lang.String receiptUrl)
void	setRefunded(java.lang.Boolean refunded)
void	setRefunds(ChargeRefundCollection refunds)
void	setReview(java.lang.String reviewId)
void	setReviewObject(Review r)
void	setShipping(ShippingDetails shipping)
void	setSource(ExternalAccount source)
void	setSourceTransfer(java.lang.String sourceTransferId)
void	setSourceTransferObject(Transfer c)
void	setStatementDescription(java.lang.String statementDescription)	Deprecated. Prefer using the statementDescriptor attribute instead.
void	setStatementDescriptor(java.lang.String statementDescriptor)
void	setStatus(java.lang.String status)
void	setTransfer(java.lang.String transferId)
void	setTransferData(Charge.TransferData transferData)
void	setTransferGroup(java.lang.String transferGroup)
void	setTransferObject(Transfer c)
Charge	update(java.util.Map<java.lang.String,java.lang.Object> params)	Update a charge.
Charge	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Update a charge.

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.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FRAUD_DETAILS

public static final java.lang.String FRAUD_DETAILS

See Also:

Constant Field Values

Constructor Detail

Charge

public Charge()

Method Detail

getApplication

public java.lang.String getApplication()

setApplication

public void setApplication(java.lang.String applicationId)

getApplicationObject

public Application getApplicationObject()

setApplicationObject

public void setApplicationObject(Application c)

getApplicationFee

public java.lang.String getApplicationFee()

setApplicationFee

public void setApplicationFee(java.lang.String applicationFeeId)

getApplicationFeeObject

public ApplicationFee getApplicationFeeObject()

setApplicationFeeObject

public void setApplicationFeeObject(ApplicationFee c)

getBalanceTransaction

public java.lang.String getBalanceTransaction()

setBalanceTransaction

public void setBalanceTransaction(java.lang.String balanceTransactionId)

getBalanceTransactionObject

public BalanceTransaction getBalanceTransactionObject()

setBalanceTransactionObject

public void setBalanceTransactionObject(BalanceTransaction c)

getCustomer

public java.lang.String getCustomer()

setCustomer

public void setCustomer(java.lang.String customerId)

getCustomerObject

public Customer getCustomerObject()

setCustomerObject

public void setCustomerObject(Customer c)

getDestination

public java.lang.String getDestination()

setDestination

public void setDestination(java.lang.String destinationId)

getDestinationObject

public Account getDestinationObject()

setDestinationObject

public void setDestinationObject(Account c)

getDispute

public java.lang.String getDispute()

setDispute

public void setDispute(java.lang.String disputeId)

getDisputeObject

public Dispute getDisputeObject()

setDisputeObject

public void setDisputeObject(Dispute dispute)

getInvoice

public java.lang.String getInvoice()

setInvoice

public void setInvoice(java.lang.String invoiceId)

getInvoiceObject

public Invoice getInvoiceObject()

setInvoiceObject

public void setInvoiceObject(Invoice c)

getOnBehalfOf

public java.lang.String getOnBehalfOf()

setOnBehalfOf

public void setOnBehalfOf(java.lang.String onBehalfOfId)

getOnBehalfOfObject

public Account getOnBehalfOfObject()

setOnBehalfOfObject

public void setOnBehalfOfObject(Account c)

getOrder

public java.lang.String getOrder()

setOrder

public void setOrder(java.lang.String orderId)

getOrderObject

public Order getOrderObject()

setOrderObject

public void setOrderObject(Order c)

getRefunds

public ChargeRefundCollection getRefunds()

Returns the refunds list.

Returns:

the refunds list

getReview

public java.lang.String getReview()

setReview

public void setReview(java.lang.String reviewId)

getReviewObject

public Review getReviewObject()

setReviewObject

public void setReviewObject(Review r)

getSourceTransfer

public java.lang.String getSourceTransfer()

setSourceTransfer

public void setSourceTransfer(java.lang.String sourceTransferId)

getSourceTransferObject

public Transfer getSourceTransferObject()

setSourceTransferObject

public void setSourceTransferObject(Transfer c)

getTransfer

public java.lang.String getTransfer()

setTransfer

public void setTransfer(java.lang.String transferId)

getTransferObject

public Transfer getTransferObject()

setTransferObject

public void setTransferObject(Transfer c)

capture

public Charge capture()
               throws StripeException

Capture a charge.

Throws:

StripeException

capture

public Charge capture(RequestOptions options)
               throws StripeException

Capture a charge.

Throws:

StripeException

capture

public Charge capture(java.util.Map<java.lang.String,java.lang.Object> params)
               throws StripeException

Capture a charge.

Throws:

StripeException

capture

public Charge capture(java.util.Map<java.lang.String,java.lang.Object> params,
                      RequestOptions options)
               throws StripeException

Capture a charge.

Throws:

StripeException

create

public static Charge create(java.util.Map<java.lang.String,java.lang.Object> params)
                     throws StripeException

Create a charge.

Throws:

StripeException

create

public static Charge create(java.util.Map<java.lang.String,java.lang.Object> params,
                            RequestOptions options)
                     throws StripeException

Create a charge.

Throws:

StripeException

list

public static ChargeCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                             throws StripeException

List all charges.

Throws:

StripeException

list

public static ChargeCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                    RequestOptions options)
                             throws StripeException

List all charges.

Throws:

StripeException

markFraudulent

public Charge markFraudulent(RequestOptions options)
                      throws StripeException

Mark the charge as fraudulent.

Throws:

StripeException

markSafe

public Charge markSafe(RequestOptions options)
                throws StripeException

Mark the charge as safe.

Throws:

StripeException

refund

@Deprecated
public Charge refund()
              throws StripeException

Deprecated.

Prefer using the Refund.create(Map) method instead.

Refund the charge.

Throws:

StripeException

refund

@Deprecated
public Charge refund(RequestOptions options)
              throws StripeException

Deprecated.

Prefer using the Refund.create(Map, RequestOptions) method instead.

Refund the charge.

Throws:

StripeException

refund

@Deprecated
public Charge refund(java.util.Map<java.lang.String,java.lang.Object> params)
              throws StripeException

Deprecated.

Prefer using the Refund.create(Map) method instead.

Refund the charge.

Throws:

StripeException

refund

@Deprecated
public Charge refund(java.util.Map<java.lang.String,java.lang.Object> params,
                     RequestOptions options)
              throws StripeException

Deprecated.

Prefer using the Refund.create(Map, RequestOptions) method instead.

Refund the charge.

Throws:

StripeException

retrieve

public static Charge retrieve(java.lang.String id)
                       throws StripeException

Retrieve a charge.

Throws:

StripeException

retrieve

public static Charge retrieve(java.lang.String id,
                              RequestOptions options)
                       throws StripeException

Retrieve a charge.

Throws:

StripeException

retrieve

public static Charge retrieve(java.lang.String id,
                              java.util.Map<java.lang.String,java.lang.Object> params,
                              RequestOptions options)
                       throws StripeException

Retrieve a charge.

Throws:

StripeException

update

public Charge update(java.util.Map<java.lang.String,java.lang.Object> params)
              throws StripeException

Update a charge.

Specified by:

update in interface MetadataStore<Charge>

Throws:

StripeException

update

public Charge update(java.util.Map<java.lang.String,java.lang.Object> params,
                     RequestOptions options)
              throws StripeException

Update a charge.

Specified by:

update in interface MetadataStore<Charge>

Throws:

StripeException

getObject

public java.lang.String getObject()

getAmount

public java.lang.Long getAmount()

getAmountRefunded

public java.lang.Long getAmountRefunded()

getApplicationFeeAmount

public java.lang.Long getApplicationFeeAmount()

getAlternateStatementDescriptors

public Charge.AlternateStatementDescriptors getAlternateStatementDescriptors()

getBillingDetails

public PaymentMethod.BillingDetails getBillingDetails()

getCaptured

public java.lang.Boolean getCaptured()

getCreated

public java.lang.Long getCreated()

getCurrency

public java.lang.String getCurrency()

getDescription

public java.lang.String getDescription()

getFailureCode

public java.lang.String getFailureCode()

getFailureMessage

public java.lang.String getFailureMessage()

getFraudDetails

public Charge.FraudDetails getFraudDetails()

getLevel3

public Charge.Level3 getLevel3()

getLivemode

public java.lang.Boolean getLivemode()

getOutcome

public Charge.Outcome getOutcome()

getPaid

public java.lang.Boolean getPaid()

getPaymentIntent

public java.lang.String getPaymentIntent()

getPaymentMethod

public java.lang.String getPaymentMethod()

getPaymentMethodDetails

public Charge.PaymentMethodDetails getPaymentMethodDetails()

getReceiptEmail

public java.lang.String getReceiptEmail()

getReceiptNumber

public java.lang.String getReceiptNumber()

getReceiptUrl

public java.lang.String getReceiptUrl()

getRefunded

public java.lang.Boolean getRefunded()

getShipping

public ShippingDetails getShipping()

getSource

public ExternalAccount getSource()

getStatementDescriptor

public java.lang.String getStatementDescriptor()

getStatus

public java.lang.String getStatus()

getTransferData

public Charge.TransferData getTransferData()

getTransferGroup

public java.lang.String getTransferGroup()

getAuthorizationCode

public java.lang.String getAuthorizationCode()

getCard

@Deprecated
public Card getCard()

Deprecated.

Prefer using the source attribute instead.

The card attribute.

Returns:

the card attribute

See Also:

API version 2015-02-18

getDisputed

@Deprecated
public java.lang.Boolean getDisputed()

Deprecated.

Prefer using the dispute attribute instead.

The disputed attribute.

Returns:

the disputed attribute

See Also:

API version 2012-11-07

getStatementDescription

@Deprecated
public java.lang.String getStatementDescription()

Deprecated.

Prefer using the statementDescriptor attribute instead.

The statement_description attribute.

Returns:

the cards attribute

See Also:

API version 2014-12-17

setId

public void setId(java.lang.String id)

setObject

public void setObject(java.lang.String object)

setAmount

public void setAmount(java.lang.Long amount)

setAmountRefunded

public void setAmountRefunded(java.lang.Long amountRefunded)

setApplicationFeeAmount

public void setApplicationFeeAmount(java.lang.Long applicationFeeAmount)

setAlternateStatementDescriptors

public void setAlternateStatementDescriptors(Charge.AlternateStatementDescriptors alternateStatementDescriptors)

setBillingDetails

public void setBillingDetails(PaymentMethod.BillingDetails billingDetails)

setCaptured

public void setCaptured(java.lang.Boolean captured)

setCreated

public void setCreated(java.lang.Long created)

setCurrency

public void setCurrency(java.lang.String currency)

setDescription

public void setDescription(java.lang.String description)

setFailureCode

public void setFailureCode(java.lang.String failureCode)

setFailureMessage

public void setFailureMessage(java.lang.String failureMessage)

setFraudDetails

public void setFraudDetails(Charge.FraudDetails fraudDetails)

setLevel3

public void setLevel3(Charge.Level3 level3)

setLivemode

public void setLivemode(java.lang.Boolean livemode)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

setOutcome

public void setOutcome(Charge.Outcome outcome)

setPaid

public void setPaid(java.lang.Boolean paid)

setPaymentIntent

public void setPaymentIntent(java.lang.String paymentIntent)

setPaymentMethod

public void setPaymentMethod(java.lang.String paymentMethod)

setPaymentMethodDetails

public void setPaymentMethodDetails(Charge.PaymentMethodDetails paymentMethodDetails)

setReceiptEmail

public void setReceiptEmail(java.lang.String receiptEmail)

setReceiptNumber

public void setReceiptNumber(java.lang.String receiptNumber)

setReceiptUrl

public void setReceiptUrl(java.lang.String receiptUrl)

setRefunded

public void setRefunded(java.lang.Boolean refunded)

setRefunds

public void setRefunds(ChargeRefundCollection refunds)

setShipping

public void setShipping(ShippingDetails shipping)

setSource

public void setSource(ExternalAccount source)

setStatementDescriptor

public void setStatementDescriptor(java.lang.String statementDescriptor)

setStatus

public void setStatus(java.lang.String status)

setTransferData

public void setTransferData(Charge.TransferData transferData)

setTransferGroup

public void setTransferGroup(java.lang.String transferGroup)

setAuthorizationCode

public void setAuthorizationCode(java.lang.String authorizationCode)

setCard

@Deprecated
public void setCard(Card card)

Deprecated.

Prefer using the source attribute instead.

The card attribute.

See Also:

API version 2015-02-18

setDisputed

@Deprecated
public void setDisputed(java.lang.Boolean disputed)

Deprecated.

Prefer using the dispute attribute instead.

The disputed attribute.

See Also:

API version 2012-11-07

setStatementDescription

@Deprecated
public void setStatementDescription(java.lang.String statementDescription)

Deprecated.

Prefer using the statementDescriptor attribute instead.

The statement_description attribute.

See Also:

API version 2014-12-17

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

Specified by:

getId in interface HasId

getMetadata

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

Specified by:

getMetadata in interface MetadataStore<Charge>