Charges

Type Members

1. case class 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) extends Product with Serializable

   

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

   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.

2. case class ChargeInput(amount: BigDecimal, currency: Currency, applicationFee: Option[BigDecimal], capture: Boolean, description: Option[String], destination: Option[String], metadata: Map[String, String], receiptEmail: Option[String], shipping: Option[Shipping], customer: Option[Customer], source: Option[Card], statementDescriptor: Option[String]) extends StripeObject with Product with Serializable

   
   amount

   A positive integer in the smallest currency unit (e.g 100 cents to charge $1.00, or 1 to charge ¥1, a 0-decimal currency) representing how much to charge the card. The minimum amount is $0.50 (or equivalent in charge currency).

   currency

   3-letter ISO code for currency.

   applicationFee

   A fee in cents that will be applied to the charge and transferred to the application owner's Stripe account. To use an application fee, the request must be made on behalf of another account, using the Stripe-Account header, an OAuth key, or the Charge.destination parameter. For more information, see the application fees documentation.

   capture

   Whether or not to immediately capture the charge. When false, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire in 7 days. For more information, see authorizing charges and settling later.

   description

   An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing.

   destination

   An account to make the charge on behalf of. If specified, the charge will be attributed to the destination account for tax reporting, and the funds from the charge will be transferred to the destination account. The ID of the resulting transfer will be returned in the transfer field of the response. See the documentation for details.

   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 customer in a structured format. It's often a good idea to store an email address in metadata for tracking later.

   receiptEmail

   The email address to send this charge's receipt to. The receipt will not be sent until the charge is paid. If this charge is for a customer, the email address specified here will override the customer's email address. Receipts will not be sent for test mode charges. If receiptEmail is specified for a charge in live mode, a receipt will be sent regardless of your email settings.

   shipping

   Shipping information for the charge. Helps prevent fraud on charges for physical goods. For more information, see the Charge object documentation.

   customer

   The ID of an existing customer that will be charged in this request.

   source

   A payment source to be charged, such as a credit card. If you also pass a customer ID, the source must be the ID of a source belonging to the customer. Otherwise, if you do not pass a customer ID, the source you provide must either be a token, like the ones returned by Stripe.js, or a dictionary containing a user's credit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud.

   statementDescriptor

   An arbitrary string to be displayed on your customer's credit card statement. This may be up to 22 characters. As an example, if your website is RunClub and the item you're charging for is a race ticket, you may want to specify a statementDescriptor of RunClub 5K race ticket. The statement description may not include <>"' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all.

   Exceptions thrown

   StatementDescriptorInvalidCharacter - If statementDescriptor has an invalid character

   StatementDescriptorTooLong - If statementDescriptor is longer than 22 characters

   See also

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

3. case class FraudDetails(userReport: Option[UserReport], stripeReport: Option[StripeReport]) extends Product with Serializable

   

4. case class MaskedSource(id: String, last4: String, expMonth: Int, expYear: Int, cvc: Option[String], addressCountry: Option[String], addressLine1: Option[String], addressLine2: Option[String], name: Option[String], addressState: Option[String], addressZip: Option[String]) extends MaskedCardSource with Product with Serializable

   

5. sealed abstract class Source extends AnyRef

   

6. sealed abstract class Status extends EnumEntry