Charge

@Serializable
data class Charge : Serializable

The Charge object contains details about a charge made to a PaymentIntent

Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Properties

Link copied to clipboard
val amount: Long = 0

The amount of the charge

Link copied to clipboard

Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).

Link copied to clipboard
val application: String? = null

ID of the Connect application that created the Charge.

Link copied to clipboard
val applicationFee: String? = null

The application fee (if any) for the Charge.

Link copied to clipboard

The amount of the application fee (if any) for the Charge.

Link copied to clipboard

6 digit authorization code for this charge.

Link copied to clipboard

ID of the balance transaction that describes the impact of this Charge on your account balance (not including refunds or disputes).

Link copied to clipboard

The full statement descriptor that is displayed on your customer's credit card's statement, after the static statementDescriptor and dynamic statementDescriptorSuffix portions are combined.

Link copied to clipboard
val captured: Boolean = false

If the Charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.

Link copied to clipboard
val created: Long = 0

Time at which the Charge was created. Measured in seconds since the Unix epoch.

Link copied to clipboard
val currency: String? = null

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Link copied to clipboard
val customer: String? = null

ID of the customer this Charge is for if one exists.

Link copied to clipboard
val description: String? = null

An arbitrary string attached to the Charge. Often useful for displaying to users.

Link copied to clipboard
val dispute: String? = null

Details about the dispute if the Charge has been disputed.

Link copied to clipboard
val failureCode: String? = null

Error code explaining reason for charge failure if available.

Link copied to clipboard
val failureMessage: String? = null

Message to user further explaining reason for charge failure if available.

Link copied to clipboard
val id: String

Unique identifier for the Charge

Link copied to clipboard
val invoice: String? = null

ID of the invoice this charge is for if one exists.

Link copied to clipboard
val livemode: Boolean = false

Has the value true if the Charge exists in live mode or the value false if the Charge exists in test mode.

Link copied to clipboard
val metadata: Map<String, String>? = null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the Charge in a structured format.

Link copied to clipboard
val onBehalfOf: String? = null

The account (if any) the Charge was made on behalf of without triggering an automatic transfer.

Link copied to clipboard
val order: String? = null

ID of the order this Charge is for if one exists.

Link copied to clipboard
val paid: Boolean = false

true if the Charge succeeded, or was successfully authorized for later capture.

Link copied to clipboard
@SerialName(value = "paymentIntent")
val paymentIntentId: String? = null

ID of the PaymentIntent associated with this Charge, if one exists.

Link copied to clipboard

A PaymentMethodDetails object containing more details about the charge

Link copied to clipboard
@SerialName(value = "paymentMethod")
val paymentMethodId: String? = null

ID of the PaymentMethod associated with this Charge, if one exists.

Link copied to clipboard
val receiptEmail: String? = null

This is the email address that the receipt for this Charge was sent to.

Link copied to clipboard
val receiptNumber: String? = null

This is the transaction number that appears on email receipts sent for this Charge. This attribute will be null until a receipt has been sent.

Link copied to clipboard
val receiptUrl: String? = null

This is the URL to view the receipt for this Charge. The receipt is kept up-to-date to the latest state of the Charge, including any refunds. If the Charge is for an Invoice, the receipt will be stylized as an Invoice receipt.

Link copied to clipboard
val refunded: Boolean = false

Whether the Charge has been fully refunded. If the Charge is only partially refunded, this attribute will still be false.

Link copied to clipboard
val review: String? = null

ID of the review associated with this Charge if one exists.

Link copied to clipboard

Extra information about a Charge. This will appear on your customer's credit card statement. It must contain at least one letter.

Link copied to clipboard

Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on your customer's credit card’s statement.

Link copied to clipboard
val status: String? = null

The status of the payment is either succeeded, pending, or failed.

Link copied to clipboard
val transfer: String? = null

ID of the transfer to the destination account (only applicable if the Charge was created using the destination parameter).

Link copied to clipboard
val transferGroup: String? = null

A string that identifies this transaction as part of a group.