Charge (stripe-java 1.43.0 API)

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/interfaces inherited from class com.stripe.net.APIResource
  APIResource.RequestMethod, APIResource.RequestType

Field Summary

Fields
Modifier and Type Field and Description

static String FRAUD_DETAILS
- Fields inherited from class com.stripe.net.APIResource
  CHARSET, GSON
- Fields inherited from class com.stripe.model.StripeObject
  PRETTY_PRINT_GSON

Fields
Modifier and Type	Field and Description
`static String`	`FRAUD_DETAILS`

Constructor Summary

Constructors
Constructor and Description

Charge()

Constructors
Constructor and Description
`Charge()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ChargeCollection`	`all(Map<String,Object> params)` Deprecated.
`static ChargeCollection`	`all(Map<String,Object> params, RequestOptions options)` Deprecated.
`static ChargeCollection`	`all(Map<String,Object> params, String apiKey)` Deprecated.
`Charge`	`capture()`
`Charge`	`capture(Map<String,Object> params)`
`Charge`	`capture(Map<String,Object> params, RequestOptions options)`
`Charge`	`capture(Map<String,Object> params, String apiKey)` Deprecated.
`Charge`	`capture(RequestOptions options)`
`Charge`	`capture(String apiKey)` Deprecated.
`Dispute`	`closeDispute()` Deprecated.
`Dispute`	`closeDispute(RequestOptions options)` Deprecated.
`Dispute`	`closeDispute(String apiKey)` Deprecated.
`static Charge`	`create(Map<String,Object> params)`
`static Charge`	`create(Map<String,Object> params, RequestOptions options)`
`static Charge`	`create(Map<String,Object> params, String apiKey)` Deprecated.
`Integer`	`getAmount()`
`Integer`	`getAmountRefunded()`
`String`	`getApplicationFee()`
`String`	`getBalanceTransaction()`
`Boolean`	`getCaptured()`
`Card`	`getCard()`
`Long`	`getCreated()`
`String`	`getCurrency()`
`String`	`getCustomer()`
`String`	`getDescription()`
`String`	`getDestination()`
`Dispute`	`getDispute()`
`Boolean`	`getDisputed()` Deprecated. Use `dispute` field (https://stripe.com/docs/upgrades#2012-11-07)
`String`	`getFailureCode()`
`String`	`getFailureMessage()`
`FraudDetails`	`getFraudDetails()`
`String`	`getId()`
`String`	`getInvoice()`
`Boolean`	`getLivemode()`
`Map<String,String>`	`getMetadata()`
`Boolean`	`getPaid()`
`String`	`getReceiptEmail()`
`String`	`getReceiptNumber()`
`Boolean`	`getRefunded()`
`ChargeRefundCollection`	`getRefunds()`
`ShippingDetails`	`getShipping()`
`ExternalAccount`	`getSource()`
`String`	`getStatementDescription()` Deprecated.
`String`	`getStatementDescriptor()`
`String`	`getStatus()`
`String`	`getTransfer()`
`static ChargeCollection`	`list(Map<String,Object> params)`
`static ChargeCollection`	`list(Map<String,Object> params, RequestOptions options)`
`Charge`	`markFraudulent(RequestOptions options)` Convenience method to mark a given charge as fraudulent.
`Charge`	`markSafe(RequestOptions options)` Convenience method to mark a given charge as not fraudulent.
`Charge`	`refund()`
`Charge`	`refund(Map<String,Object> params)`
`Charge`	`refund(Map<String,Object> params, RequestOptions options)`
`Charge`	`refund(Map<String,Object> params, String apiKey)` Deprecated.
`Charge`	`refund(RequestOptions options)`
`Charge`	`refund(String apiKey)` Deprecated.
`static Charge`	`retrieve(String id)`
`static Charge`	`retrieve(String id, RequestOptions options)`
`static Charge`	`retrieve(String id, String apiKey)` Deprecated.
`void`	`setAmount(Integer amount)`
`void`	`setAmountRefunded(Integer amountRefunded)`
`void`	`setApplicationFee(String applicationFee)`
`void`	`setBalanceTransaction(String balanceTransaction)`
`void`	`setCaptured(Boolean captured)`
`void`	`setCard(Card card)`
`void`	`setCreated(Long created)`
`void`	`setCurrency(String currency)`
`void`	`setCustomer(String customer)`
`void`	`setDescription(String description)`
`void`	`setDestination(String destination)`
`void`	`setDispute(Dispute dispute)`
`void`	`setDisputed(Boolean disputed)` Deprecated. Use `dispute` field (https://stripe.com/docs/upgrades#2012-11-07)
`void`	`setFailureCode(String failureCode)`
`void`	`setFailureMessage(String failureMessage)`
`void`	`setFraudDetails(FraudDetails fraudDetails)`
`void`	`setId(String id)`
`void`	`setInvoice(String invoice)`
`void`	`setLivemode(Boolean livemode)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setPaid(Boolean paid)`
`void`	`setReceiptEmail(String receiptEmail)`
`void`	`setReceiptNumber(String receiptNumber)`
`void`	`setRefunded(Boolean refunded)`
`void`	`setShipping(ShippingDetails shipping)`
`void`	`setSource(ExternalAccount source)`
`void`	`setStatementDescription(String statementDescription)` Deprecated.
`void`	`setStatementDescriptor(String statementDescriptor)`
`void`	`setStatus(String status)`
`void`	`setTransfer(String transfer)`
`Charge`	`update(Map<String,Object> params)`
`Charge`	`update(Map<String,Object> params, RequestOptions options)`
`Charge`	`update(Map<String,Object> params, String apiKey)` Deprecated.
`Dispute`	`updateDispute(Map<String,Object> params)` Deprecated.
`Dispute`	`updateDispute(Map<String,Object> params, RequestOptions options)` Deprecated.
`Dispute`	`updateDispute(Map<String,Object> params, String apiKey)` Deprecated.

Methods inherited from class com.stripe.net.APIResource
classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setStripeResponseGetter, singleClassURL, singleClassURL, urlEncode

Methods inherited from class com.stripe.model.StripeObject
equals, toString

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

Field Detail
- FRAUD_DETAILS
```
public static final String FRAUD_DETAILS
```
  See Also:
  
  Constant Field Values

Constructor Detail
- Charge
```
public Charge()
```

Method Detail

getFraudDetails
```
public FraudDetails getFraudDetails()
```

setFraudDetails

public void setFraudDetails(FraudDetails fraudDetails)

getId
```
public String getId()
```
Specified by:

getId in interface HasId

setId
```
public void setId(String id)
```

getStatus
```
public String getStatus()
```

setStatus
```
public void setStatus(String status)
```

getApplicationFee
```
public String getApplicationFee()
```

setApplicationFee

public void setApplicationFee(String applicationFee)

getAmount
```
public Integer getAmount()
```

setAmount

public void setAmount(Integer amount)

getCreated
```
public Long getCreated()
```

setCreated
```
public void setCreated(Long created)
```

getCurrency
```
public String getCurrency()
```

setCurrency

public void setCurrency(String currency)

getLivemode
```
public Boolean getLivemode()
```

setLivemode

public void setLivemode(Boolean livemode)

getPaid
```
public Boolean getPaid()
```

setPaid
```
public void setPaid(Boolean paid)
```

getRefunded
```
public Boolean getRefunded()
```

setRefunded

public void setRefunded(Boolean refunded)

getCaptured
```
public Boolean getCaptured()
```

setCaptured

public void setCaptured(Boolean captured)

getShipping
```
public ShippingDetails getShipping()
```

setShipping

public void setShipping(ShippingDetails shipping)

getDisputed
```
@Deprecated
public Boolean getDisputed()
```
Deprecated. Use `dispute` field (https://stripe.com/docs/upgrades#2012-11-07)

setDisputed
```
@Deprecated
public void setDisputed(Boolean disputed)
```
Deprecated. Use `dispute` field (https://stripe.com/docs/upgrades#2012-11-07)

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getStatementDescriptor

public String getStatementDescriptor()

setStatementDescriptor

public void setStatementDescriptor(String statementDescriptor)

getStatementDescription

@Deprecated
public String getStatementDescription()

Deprecated.

setStatementDescription

@Deprecated
public void setStatementDescription(String statementDescription)

Deprecated.

getFailureMessage
```
public String getFailureMessage()
```

setFailureMessage

public void setFailureMessage(String failureMessage)

getFailureCode
```
public String getFailureCode()
```

setFailureCode

public void setFailureCode(String failureCode)

getAmountRefunded
```
public Integer getAmountRefunded()
```

setAmountRefunded

public void setAmountRefunded(Integer amountRefunded)

getCustomer
```
public String getCustomer()
```

setCustomer

public void setCustomer(String customer)

getInvoice
```
public String getInvoice()
```

setInvoice

public void setInvoice(String invoice)

getRefunds

public ChargeRefundCollection getRefunds()

getCard
```
public Card getCard()
```

setCard
```
public void setCard(Card card)
```

getDispute
```
public Dispute getDispute()
```

setDispute

public void setDispute(Dispute dispute)

getBalanceTransaction
```
public String getBalanceTransaction()
```

setBalanceTransaction

public void setBalanceTransaction(String balanceTransaction)

getMetadata
```
public Map<String,String> getMetadata()
```
Specified by:

getMetadata in interface MetadataStore<Charge>

setMetadata

public void setMetadata(Map<String,String> metadata)

getReceiptNumber
```
public String getReceiptNumber()
```

setReceiptNumber

public void setReceiptNumber(String receiptNumber)

getReceiptEmail
```
public String getReceiptEmail()
```

setReceiptEmail

public void setReceiptEmail(String receiptEmail)

getSource
```
public ExternalAccount getSource()
```

setSource

public void setSource(ExternalAccount source)

getTransfer
```
public String getTransfer()
```

setTransfer

public void setTransfer(String transfer)

getDestination
```
public String getDestination()
```

setDestination

public void setDestination(String destination)

create

public static Charge create(Map<String,Object> params)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

public static Charge retrieve(String id)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

public Charge update(Map<String,Object> params)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Specified by:: update in interface MetadataStore<Charge>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

refund

public Charge refund()
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

capture

public Charge capture()
               throws AuthenticationException,
                      InvalidRequestException,
                      APIConnectionException,
                      CardException,
                      APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

updateDispute

@Deprecated
public Dispute updateDispute(Map<String,Object> params)
                                  throws AuthenticationException,
                                         InvalidRequestException,
                                         APIConnectionException,
                                         CardException,
                                         APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

closeDispute

@Deprecated
public Dispute closeDispute()
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

refund

public Charge refund(Map<String,Object> params)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

capture

public Charge capture(Map<String,Object> params)
               throws AuthenticationException,
                      InvalidRequestException,
                      APIConnectionException,
                      CardException,
                      APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

create

@Deprecated
public static Charge create(Map<String,Object> params,
                                        String apiKey)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

create

public static Charge create(Map<String,Object> params,
                            RequestOptions options)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

@Deprecated
public static Charge retrieve(String id,
                                          String apiKey)
                                   throws AuthenticationException,
                                          InvalidRequestException,
                                          APIConnectionException,
                                          CardException,
                                          APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

public static Charge retrieve(String id,
                              RequestOptions options)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

@Deprecated
public Charge update(Map<String,Object> params,
                                 String apiKey)
                          throws AuthenticationException,
                                 InvalidRequestException,
                                 APIConnectionException,
                                 CardException,
                                 APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

public Charge update(Map<String,Object> params,
                     RequestOptions options)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Specified by:: update in interface MetadataStore<Charge>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

list

public static ChargeCollection list(Map<String,Object> params)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

list

public static ChargeCollection list(Map<String,Object> params,
                                    RequestOptions options)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

@Deprecated
public static ChargeCollection all(Map<String,Object> params)
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

@Deprecated
public static ChargeCollection all(Map<String,Object> params,
                                               String apiKey)
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

@Deprecated
public static ChargeCollection all(Map<String,Object> params,
                                               RequestOptions options)
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

refund

@Deprecated
public Charge refund(String apiKey)
                          throws AuthenticationException,
                                 InvalidRequestException,
                                 APIConnectionException,
                                 CardException,
                                 APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

refund

public Charge refund(RequestOptions options)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

refund

@Deprecated
public Charge refund(Map<String,Object> params,
                                 String apiKey)
                          throws AuthenticationException,
                                 InvalidRequestException,
                                 APIConnectionException,
                                 CardException,
                                 APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

refund

public Charge refund(Map<String,Object> params,
                     RequestOptions options)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

capture

@Deprecated
public Charge capture(String apiKey)
                           throws AuthenticationException,
                                  InvalidRequestException,
                                  APIConnectionException,
                                  CardException,
                                  APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

capture

public Charge capture(RequestOptions options)
               throws AuthenticationException,
                      InvalidRequestException,
                      APIConnectionException,
                      CardException,
                      APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

capture

@Deprecated
public Charge capture(Map<String,Object> params,
                                  String apiKey)
                           throws AuthenticationException,
                                  InvalidRequestException,
                                  APIConnectionException,
                                  CardException,
                                  APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

capture

public Charge capture(Map<String,Object> params,
                      RequestOptions options)
               throws AuthenticationException,
                      InvalidRequestException,
                      APIConnectionException,
                      CardException,
                      APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

updateDispute

@Deprecated
public Dispute updateDispute(Map<String,Object> params,
                                         String apiKey)
                                  throws AuthenticationException,
                                         InvalidRequestException,
                                         APIConnectionException,
                                         CardException,
                                         APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

updateDispute

@Deprecated
public Dispute updateDispute(Map<String,Object> params,
                                         RequestOptions options)
                                  throws AuthenticationException,
                                         InvalidRequestException,
                                         APIConnectionException,
                                         CardException,
                                         APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

closeDispute

@Deprecated
public Dispute closeDispute(String apiKey)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

closeDispute

@Deprecated
public Dispute closeDispute(RequestOptions options)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

markFraudulent

public Charge markFraudulent(RequestOptions options)
                      throws AuthenticationException,
                             InvalidRequestException,
                             APIConnectionException,
                             CardException,
                             APIException

Convenience method to mark a given charge as fraudulent.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

markSafe

public Charge markSafe(RequestOptions options)
                throws AuthenticationException,
                       InvalidRequestException,
                       APIConnectionException,
                       CardException,
                       APIException

Convenience method to mark a given charge as not fraudulent.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

Class Charge

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

Field Detail

FRAUD_DETAILS

Constructor Detail

Charge

Method Detail

getFraudDetails

setFraudDetails

getId

setId

getStatus

setStatus

getApplicationFee

setApplicationFee

getAmount

setAmount

getCreated

setCreated

getCurrency

setCurrency

getLivemode

setLivemode

getPaid

setPaid

getRefunded

setRefunded

getCaptured

setCaptured

getShipping

setShipping

getDisputed

setDisputed

getDescription

setDescription

getStatementDescriptor

setStatementDescriptor

getStatementDescription

setStatementDescription

getFailureMessage

setFailureMessage

getFailureCode

setFailureCode

getAmountRefunded

setAmountRefunded

getCustomer

setCustomer

getInvoice

setInvoice

getRefunds

getCard

setCard

getDispute

setDispute

getBalanceTransaction

setBalanceTransaction

getMetadata

setMetadata

getReceiptNumber

setReceiptNumber

getReceiptEmail

setReceiptEmail

getSource

setSource

getTransfer

setTransfer

getDestination

setDestination

create

retrieve

update