public class Charge
The Charge
object contains details about a charge made to a class PaymentIntent
Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal
class PaymentIntent
Modifier and Type | Method and Description |
---|---|
java.lang.String |
component1()
Unique identifier for the
|
java.lang.String |
component10()
Three-letter ISO currency code,
|
java.lang.String |
component11()
ID of the customer this
|
java.lang.String |
component12()
An arbitrary string attached to the
|
java.lang.String |
component13()
Details about the dispute if the
|
java.lang.String |
component14()
Error code explaining reason for charge failure if available.
|
java.lang.String |
component15()
Message to user further explaining reason for charge failure if available.
|
java.lang.String |
component16()
ID of the invoice this charge is for if one exists.
|
boolean |
component17()
Has the value
|
java.util.Map<java.lang.String,java.lang.String> |
component18()
Set of key-value pairs that you can attach to an object.
|
java.lang.String |
component19()
The account
|
int |
component2()
The amount of the charge
|
java.lang.String |
component20()
ID of the order this
|
boolean |
component21()
true |
java.lang.String |
component22()
ID of the PaymentIntent associated with this
|
java.lang.String |
component23()
ID of the
|
PaymentMethodDetails |
component24()
A
|
java.lang.String |
component25()
This is the email address that the receipt for this
|
java.lang.String |
component26()
This is the transaction number that appears on email receipts sent for this
|
java.lang.String |
component27()
This is the URL to view the receipt for this
|
boolean |
component28()
Whether the
|
java.lang.String |
component29()
ID of the review associated with this
|
int |
component3()
Amount in cents refunded
|
java.lang.String |
component30()
Extra information about a
|
java.lang.String |
component31()
The status of the payment is either
|
java.lang.String |
component32()
ID of the transfer to the
|
java.lang.String |
component33()
A string that identifies this transaction as part of a group.
|
java.lang.String |
component4()
ID of the Connect application that created the
|
java.lang.String |
component5()
The application fee
|
int |
component6()
The amount of the application fee
|
java.lang.String |
component7()
ID of the balance transaction that describes the impact of this
|
boolean |
component8()
If the
|
long |
component9()
Time at which the
|
Charge |
copy(java.lang.String id,
int amount,
int amountRefunded,
java.lang.String application,
java.lang.String applicationFee,
int applicationFeeAmount,
java.lang.String balanceTransaction,
boolean captured,
long created,
java.lang.String currency,
java.lang.String customer,
java.lang.String description,
java.lang.String dispute,
java.lang.String failureCode,
java.lang.String failureMessage,
java.lang.String invoice,
boolean livemode,
java.util.Map<java.lang.String,java.lang.String> metadata,
java.lang.String onBehalfOf,
java.lang.String order,
boolean paid,
java.lang.String paymentIntentId,
java.lang.String paymentMethodId,
PaymentMethodDetails paymentMethodDetails,
java.lang.String receiptEmail,
java.lang.String receiptNumber,
java.lang.String receiptUrl,
boolean refunded,
java.lang.String review,
java.lang.String statementDescriptor,
java.lang.String status,
java.lang.String transfer,
java.lang.String transferGroup)
The
Charge object contains details about a charge made to a class PaymentIntent |
boolean |
equals(java.lang.Object p) |
int |
getAmount()
The amount of the charge
|
int |
getAmountRefunded()
Amount in cents refunded
|
java.lang.String |
getApplication()
ID of the Connect application that created the
|
java.lang.String |
getApplicationFee()
The application fee
|
int |
getApplicationFeeAmount()
The amount of the application fee
|
java.lang.String |
getBalanceTransaction()
ID of the balance transaction that describes the impact of this
|
boolean |
getCaptured()
If the
|
long |
getCreated()
Time at which the
|
java.lang.String |
getCurrency()
Three-letter ISO currency code,
|
java.lang.String |
getCustomer()
ID of the customer this
|
java.lang.String |
getDescription()
An arbitrary string attached to the
|
java.lang.String |
getDispute()
Details about the dispute if the
|
java.lang.String |
getFailureCode()
Error code explaining reason for charge failure if available.
|
java.lang.String |
getFailureMessage()
Message to user further explaining reason for charge failure if available.
|
java.lang.String |
getId()
Unique identifier for the
|
java.lang.String |
getInvoice()
ID of the invoice this charge is for if one exists.
|
boolean |
getLivemode()
Has the value
|
java.util.Map<java.lang.String,java.lang.String> |
getMetadata()
Set of key-value pairs that you can attach to an object.
|
java.lang.String |
getOnBehalfOf()
The account
|
java.lang.String |
getOrder()
ID of the order this
|
boolean |
getPaid()
true |
java.lang.String |
getPaymentIntentId()
ID of the PaymentIntent associated with this
|
PaymentMethodDetails |
getPaymentMethodDetails()
A
|
java.lang.String |
getPaymentMethodId()
ID of the
|
java.lang.String |
getReceiptEmail()
This is the email address that the receipt for this
|
java.lang.String |
getReceiptNumber()
This is the transaction number that appears on email receipts sent for this
|
java.lang.String |
getReceiptUrl()
This is the URL to view the receipt for this
|
boolean |
getRefunded()
Whether the
|
java.lang.String |
getReview()
ID of the review associated with this
|
java.lang.String |
getStatementDescriptor()
Extra information about a
|
java.lang.String |
getStatus()
The status of the payment is either
|
java.lang.String |
getTransfer()
ID of the transfer to the
|
java.lang.String |
getTransferGroup()
A string that identifies this transaction as part of a group.
|
int |
hashCode() |
java.lang.String |
toString() |
@NotNull public java.lang.String getId()
Unique identifier for the
Charge
public int getAmount()
The amount of the charge
public int getAmountRefunded()
Amount in cents refunded
(can be less than the amount attribute on the charge if a partialrefund was issued).
@Nullable public java.lang.String getApplication()
ID of the Connect application that created the
Charge
.
@Nullable public java.lang.String getApplicationFee()
The application fee
(if any) for the Charge
.
public int getApplicationFeeAmount()
The amount of the application fee
(if any) for the Charge
.
@Nullable public java.lang.String getBalanceTransaction()
ID of the balance transaction that describes the impact of this
Charge
on your accountbalance (not including refunds or disputes).
public boolean getCaptured()
If the
Charge
was created without capturing, this Boolean represents whether it is stilluncaptured or has since been captured.
public long getCreated()
Time at which the
Charge
was created. Measured in seconds since the Unix epoch.
@Nullable public java.lang.String getCurrency()
Three-letter ISO currency code,
in lowercase. Must be a supported currency.
@Nullable public java.lang.String getCustomer()
ID of the customer this
Charge
is for if one exists.
@Nullable public java.lang.String getDescription()
An arbitrary string attached to the
Charge
. Often useful for displaying to users.
@Nullable public java.lang.String getDispute()
Details about the dispute if the
Charge
has been disputed.
@Nullable public java.lang.String getFailureCode()
Error code explaining reason for charge failure if available.
@Nullable public java.lang.String getFailureMessage()
Message to user further explaining reason for charge failure if available.
@Nullable public java.lang.String getInvoice()
ID of the invoice this charge is for if one exists.
public boolean getLivemode()
Has the value
true
if the Charge
exists in live mode or the value false
if the Charge
exists in test mode.
@Nullable public java.util.Map<java.lang.String,java.lang.String> getMetadata()
Set of key-value pairs that you can attach to an object.
This can be useful for storingadditional information about the Charge
in a structured format.
@Nullable public java.lang.String getOnBehalfOf()
The account
(if any) the Charge
was made on behalf of without triggering an automatictransfer.
@Nullable public java.lang.String getOrder()
ID of the order this
Charge
is for if one exists.
public boolean getPaid()
true
if the Charge
succeeded, or was successfully authorized for later capture.
@Nullable public java.lang.String getPaymentIntentId()
ID of the PaymentIntent associated with this
Charge
, if one exists.
@Nullable public java.lang.String getPaymentMethodId()
ID of the
class PaymentMethod
associated with this Charge
, if one exists.
class PaymentMethod
@Nullable public PaymentMethodDetails getPaymentMethodDetails()
A
class PaymentMethodDetails
object containing more details about the charge
class PaymentMethodDetails
@Nullable public java.lang.String getReceiptEmail()
This is the email address that the receipt for this
Charge
was sent to.
@Nullable public java.lang.String getReceiptNumber()
This is the transaction number that appears on email receipts sent for this
Charge
. Thisattribute will be null
until a receipt has been sent.
@Nullable public java.lang.String getReceiptUrl()
This is the URL to view the receipt for this
Charge
. The receipt is kept up-to-date to thelatest state of the Charge
, including any refunds. If the Charge
is for an Invoice, thereceipt will be stylized as an Invoice receipt.
public boolean getRefunded()
Whether the
Charge
has been fully refunded. If the Charge
is only partially refunded,this attribute will still be false.
@Nullable public java.lang.String getReview()
ID of the review associated with this
Charge
if one exists.
@Nullable public java.lang.String getStatementDescriptor()
Extra information about a
Charge
. This will appear on your customer's credit cardstatement. It must contain at least one letter.
@Nullable public java.lang.String getStatus()
The status of the payment is either
succeeded
, pending
, or failed
.
@Nullable public java.lang.String getTransfer()
ID of the transfer to the
destination
account (only applicable if the Charge
was createdusing the destination
parameter).
@Nullable public java.lang.String getTransferGroup()
A string that identifies this transaction as part of a group.
@NotNull public java.lang.String component1()
Unique identifier for the
Charge
public int component2()
The amount of the charge
public int component3()
Amount in cents refunded
(can be less than the amount attribute on the charge if a partialrefund was issued).
@Nullable public java.lang.String component4()
ID of the Connect application that created the
Charge
.
@Nullable public java.lang.String component5()
The application fee
(if any) for the Charge
.
public int component6()
The amount of the application fee
(if any) for the Charge
.
@Nullable public java.lang.String component7()
ID of the balance transaction that describes the impact of this
Charge
on your accountbalance (not including refunds or disputes).
public boolean component8()
If the
Charge
was created without capturing, this Boolean represents whether it is stilluncaptured or has since been captured.
public long component9()
Time at which the
Charge
was created. Measured in seconds since the Unix epoch.
@Nullable public java.lang.String component10()
Three-letter ISO currency code,
in lowercase. Must be a supported currency.
@Nullable public java.lang.String component11()
ID of the customer this
Charge
is for if one exists.
@Nullable public java.lang.String component12()
An arbitrary string attached to the
Charge
. Often useful for displaying to users.
@Nullable public java.lang.String component13()
Details about the dispute if the
Charge
has been disputed.
@Nullable public java.lang.String component14()
Error code explaining reason for charge failure if available.
@Nullable public java.lang.String component15()
Message to user further explaining reason for charge failure if available.
@Nullable public java.lang.String component16()
ID of the invoice this charge is for if one exists.
public boolean component17()
Has the value
true
if the Charge
exists in live mode or the value false
if the Charge
exists in test mode.
@Nullable public java.util.Map<java.lang.String,java.lang.String> component18()
Set of key-value pairs that you can attach to an object.
This can be useful for storingadditional information about the Charge
in a structured format.
@Nullable public java.lang.String component19()
The account
(if any) the Charge
was made on behalf of without triggering an automatictransfer.
@Nullable public java.lang.String component20()
ID of the order this
Charge
is for if one exists.
public boolean component21()
true
if the Charge
succeeded, or was successfully authorized for later capture.
@Nullable public java.lang.String component22()
ID of the PaymentIntent associated with this
Charge
, if one exists.
@Nullable public java.lang.String component23()
ID of the
class PaymentMethod
associated with this Charge
, if one exists.
class PaymentMethod
@Nullable public PaymentMethodDetails component24()
A
class PaymentMethodDetails
object containing more details about the charge
class PaymentMethodDetails
@Nullable public java.lang.String component25()
This is the email address that the receipt for this
Charge
was sent to.
@Nullable public java.lang.String component26()
This is the transaction number that appears on email receipts sent for this
Charge
. Thisattribute will be null
until a receipt has been sent.
@Nullable public java.lang.String component27()
This is the URL to view the receipt for this
Charge
. The receipt is kept up-to-date to thelatest state of the Charge
, including any refunds. If the Charge
is for an Invoice, thereceipt will be stylized as an Invoice receipt.
public boolean component28()
Whether the
Charge
has been fully refunded. If the Charge
is only partially refunded,this attribute will still be false.
@Nullable public java.lang.String component29()
ID of the review associated with this
Charge
if one exists.
@Nullable public java.lang.String component30()
Extra information about a
Charge
. This will appear on your customer's credit cardstatement. It must contain at least one letter.
@Nullable public java.lang.String component31()
The status of the payment is either
succeeded
, pending
, or failed
.
@Nullable public java.lang.String component32()
ID of the transfer to the
destination
account (only applicable if the Charge
was createdusing the destination
parameter).
@Nullable public java.lang.String component33()
A string that identifies this transaction as part of a group.
@NotNull public Charge copy(@NotNull java.lang.String id, int amount, int amountRefunded, @Nullable java.lang.String application, @Nullable java.lang.String applicationFee, int applicationFeeAmount, @Nullable java.lang.String balanceTransaction, boolean captured, long created, @Nullable java.lang.String currency, @Nullable java.lang.String customer, @Nullable java.lang.String description, @Nullable java.lang.String dispute, @Nullable java.lang.String failureCode, @Nullable java.lang.String failureMessage, @Nullable java.lang.String invoice, boolean livemode, @Nullable java.util.Map<java.lang.String,java.lang.String> metadata, @Nullable java.lang.String onBehalfOf, @Nullable java.lang.String order, boolean paid, @Nullable java.lang.String paymentIntentId, @Nullable java.lang.String paymentMethodId, @Nullable PaymentMethodDetails paymentMethodDetails, @Nullable java.lang.String receiptEmail, @Nullable java.lang.String receiptNumber, @Nullable java.lang.String receiptUrl, boolean refunded, @Nullable java.lang.String review, @Nullable java.lang.String statementDescriptor, @Nullable java.lang.String status, @Nullable java.lang.String transfer, @Nullable java.lang.String transferGroup)
The Charge
object contains details about a charge made to a class PaymentIntent
Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal
class PaymentIntent
@NotNull public java.lang.String toString()
public int hashCode()
public boolean equals(@Nullable java.lang.Object p)