Charge

https://stripe.com/docs/api#charges

amount: Amount charged in cents
amountRefunded: Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).
applicationFee: The application fee (if any) for the charge. See the Connect documentation for details.
balanceTransaction: ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
captured: If the charge was created without capturing, this boolean represents whether or not it is still uncaptured or has since been captured.
currency: Three-letter ISO currency code representing the currency in which the charge was made.
customer: ID of the customer this charge is for if one exists.
destination: The account (if any) the charge was made on behalf of. See the Connect documentation for details.
dispute: Details about the dispute if the charge has been disputed.
failureCode: Error code explaining reason for charge failure if available (see the errors section for a list of codes).
failureMessage: Message to user further explaining reason for charge failure if available.
fraudDetails: Hash with information on fraud assessments for the charge. Assessments reported by you have the key FraudDetails.UserReport and, if set, possible values of FraudDetails.UserReport.Safe and FraudDetails.UserReport.Fraudulent. Assessments from Stripe have the key FraudDetails.StripeReport and, if set, the value FraudDetails.StripeReport.Fraudulent.
invoice: ID of the invoice this charge is for if one exists.
metadata: A set of key/value pairs that you can attach to a charge object. It can be useful for storing additional information about the charge in a structured format.
order: ID of the order this charge is for if one exists.
paid: true if the charge succeeded, or was successfully authorized for later capture.
receiptEmail: This is the email address that the receipt for this charge was sent to.
receiptNumber: This is the transaction number that appears on email receipts sent for this charge.
refunded: Whether or not the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
refunds: A list of refunds that have been applied to the charge.
shipping: Shipping information for the charge.
source: For most Stripe users, the source of every charge is a credit or debit card. This hash is then the card object describing that card.
sourceTransfer: The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.
statementDescriptor: Extra information about a charge. This will appear on your customer’s credit card statement.
status: The status of the payment is either Status.Succeeded, Status.Pending, or Status.Failed.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Charge(id: String, amount: BigDecimal, amountRefunded: BigDecimal, applicationFee: Option[String], balanceTransaction: String, captured: Boolean, created: OffsetDateTime, currency: Currency, customer: Option[String], description: Option[String], destination: Option[String], dispute: Option[Dispute], failureCode: Option[Type], failureMessage: Option[String], fraudDetails: Option[FraudDetails], invoice: Option[String], livemode: Boolean, metadata: Option[Map[String, String]], order: Option[String], paid: Boolean, receiptEmail: Option[String], receiptNumber: Option[String], refunded: Boolean, refunds: Option[RefundList], shipping: Option[Shipping], source: MaskedSource, sourceTransfer: Option[String], statementDescriptor: Option[String], status: Status)

amount
Amount charged in cents
amountRefunded
Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).
applicationFee
The application fee (if any) for the charge. See the Connect documentation for details.
balanceTransaction
ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
captured
If the charge was created without capturing, this boolean represents whether or not it is still uncaptured or has since been captured.
currency
Three-letter ISO currency code representing the currency in which the charge was made.
customer
ID of the customer this charge is for if one exists.
destination
The account (if any) the charge was made on behalf of. See the Connect documentation for details.
dispute
Details about the dispute if the charge has been disputed.
failureCode
Error code explaining reason for charge failure if available (see the errors section for a list of codes).
failureMessage
Message to user further explaining reason for charge failure if available.
fraudDetails
Hash with information on fraud assessments for the charge. Assessments reported by you have the key FraudDetails.UserReport and, if set, possible values of FraudDetails.UserReport.Safe and FraudDetails.UserReport.Fraudulent. Assessments from Stripe have the key FraudDetails.StripeReport and, if set, the value FraudDetails.StripeReport.Fraudulent.
invoice
ID of the invoice this charge is for if one exists.
metadata
A set of key/value pairs that you can attach to a charge object. It can be useful for storing additional information about the charge in a structured format.
order
ID of the order this charge is for if one exists.
paid
true if the charge succeeded, or was successfully authorized for later capture.
receiptEmail
This is the email address that the receipt for this charge was sent to.
receiptNumber
This is the transaction number that appears on email receipts sent for this charge.
refunded
Whether or not the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
refunds
A list of refunds that have been applied to the charge.
shipping
Shipping information for the charge.
source
For most Stripe users, the source of every charge is a credit or debit card. This hash is then the card object describing that card.
sourceTransfer
The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.
statementDescriptor
Extra information about a charge. This will appear on your customer’s credit card statement.
status
The status of the payment is either Status.Succeeded, Status.Pending, or Status.Failed.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val amount: BigDecimal

Amount charged in cents
val amountRefunded: BigDecimal

Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).
val applicationFee: Option[String]

The application fee (if any) for the charge.
The application fee (if any) for the charge. See the Connect documentation for details.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val balanceTransaction: String

ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
val captured: Boolean

If the charge was created without capturing, this boolean represents whether or not it is still uncaptured or has since been captured.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val created: OffsetDateTime
val currency: Currency

Three-letter ISO currency code representing the currency in which the charge was made.
val customer: Option[String]

ID of the customer this charge is for if one exists.
val description: Option[String]
val destination: Option[String]

The account (if any) the charge was made on behalf of.
The account (if any) the charge was made on behalf of. See the Connect documentation for details.
val dispute: Option[Dispute]

Details about the dispute if the charge has been disputed.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val failureCode: Option[Type]

Error code explaining reason for charge failure if available (see the errors section for a list of codes).
val failureMessage: Option[String]

Message to user further explaining reason for charge failure if available.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val fraudDetails: Option[FraudDetails]

Hash with information on fraud assessments for the charge.
Hash with information on fraud assessments for the charge. Assessments reported by you have the key FraudDetails.UserReport and, if set, possible values of FraudDetails.UserReport.Safe and FraudDetails.UserReport.Fraudulent. Assessments from Stripe have the key FraudDetails.StripeReport and, if set, the value FraudDetails.StripeReport.Fraudulent.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val id: String
val invoice: Option[String]

ID of the invoice this charge is for if one exists.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val livemode: Boolean
val metadata: Option[Map[String, String]]

A set of key/value pairs that you can attach to a charge object.
A set of key/value pairs that you can attach to a charge object. It can be useful for storing additional information about the charge in a structured format.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val order: Option[String]

ID of the order this charge is for if one exists.
val paid: Boolean

true if the charge succeeded, or was successfully authorized for later capture.
val receiptEmail: Option[String]

This is the email address that the receipt for this charge was sent to.
val receiptNumber: Option[String]

This is the transaction number that appears on email receipts sent for this charge.
val refunded: Boolean

Whether or not the charge has been fully refunded.
Whether or not the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
val refunds: Option[RefundList]

A list of refunds that have been applied to the charge.
val shipping: Option[Shipping]

Shipping information for the charge.
val source: MaskedSource

For most Stripe users, the source of every charge is a credit or debit card.
For most Stripe users, the source of every charge is a credit or debit card. This hash is then the card object describing that card.
val sourceTransfer: Option[String]

The transfer ID which created this charge.
The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.
val statementDescriptor: Option[String]

Extra information about a charge.
Extra information about a charge. This will appear on your customer’s credit card statement.
val status: Status

The status of the payment is either Status.Succeeded, Status.Pending, or Status.Failed.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package Charges

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val amount: BigDecimal

val amountRefunded: BigDecimal

val applicationFee: Option[String]

final def asInstanceOf[T0]: T0

val balanceTransaction: String

val captured: Boolean

def clone(): AnyRef

val created: OffsetDateTime

val currency: Currency

val customer: Option[String]

val description: Option[String]

val destination: Option[String]

val dispute: Option[Dispute]

final def eq(arg0: AnyRef): Boolean

val failureCode: Option[Type]

val failureMessage: Option[String]

def finalize(): Unit

val fraudDetails: Option[FraudDetails]

final def getClass(): Class[_]

val id: String

val invoice: Option[String]

final def isInstanceOf[T0]: Boolean

val livemode: Boolean

val metadata: Option[Map[String, String]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val order: Option[String]

val paid: Boolean

val receiptEmail: Option[String]

val receiptNumber: Option[String]

val refunded: Boolean

val refunds: Option[RefundList]

val shipping: Option[Shipping]

val source: MaskedSource

val sourceTransfer: Option[String]

val statementDescriptor: Option[String]

val status: Status

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped