Stripe::Charge
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
The Charge object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations.
Constants
Constructors
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance methods
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned
Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
Custom attribute writer method checking allowed values (enum). @param [Object] amount_captured Object to be assigned
Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
Custom attribute writer method checking allowed values (enum). @param [Object] amount_refunded Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] application Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] application_fee Object to be assigned
The amount of the application fee (if any) requested for the charge. See the Connect documentation for details.
Custom attribute writer method checking allowed values (enum). @param [Object] application_fee_amount Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] authorization_code Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] balance_transaction Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] billing_details Object to be assigned
The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.
Custom attribute writer method checking allowed values (enum). @param [Object] calculated_statement_descriptor Object to be assigned
If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
Custom attribute writer method checking allowed values (enum). @param [Object] captured Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] customer Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] disputed Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] failure_balance_transaction Object to be assigned
Error code explaining reason for charge failure if available (see the errors section for a list of codes).
Custom attribute writer method checking allowed values (enum). @param [Object] failure_code Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] failure_message Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] fraud_details Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] invoice Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] level3 Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] on_behalf_of Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] outcome Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] paid Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_intent Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_method Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_method_details Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] radar_options Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] receipt_email Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] receipt_number Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] receipt_url Object to be assigned
Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
Custom attribute writer method checking allowed values (enum). @param [Object] refunded Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] refunds Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] review Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] shipping Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] source Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] source_transfer Object to be assigned
For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs. For a card charge, this value is ignored unless you don't specify a statement_descriptor_suffix, in which case this value is used as the suffix.
Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor Object to be assigned
Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor_suffix Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] transfer Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] transfer_data Object to be assigned
A string that identifies this transaction as part of a group. See the Connect documentation for details.
Custom attribute writer method checking allowed values (enum). @param [Object] transfer_group Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid