Class: Stripe::Charge

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List, APIOperations::NestedResource, APIOperations::Search
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/charge.rb

Overview

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 [Account Debits](docs.stripe.com/connect/account-debits) may also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations.

Defined Under Namespace

Classes: BillingDetails, FraudDetails, Level3, Outcome, PaymentMethodDetails, PresentmentDetails, RadarOptions, Shipping, TransferData

Constant Summary collapse

OBJECT_NAME = 
"charge"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::NestedResource

nested_resource_class_methods

Methods included from APIOperations::Search

_search

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#allocated_funds ⇒ Object (readonly)

Funds that are in transit and destined for another balance or another connected account.



2562
2563
2564
 
# File 'lib/stripe/resources/charge.rb', line 2562

def allocated_funds
  @allocated_funds
end

#amount ⇒ Object (readonly)

Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](docs.stripe.com/currencies#zero-decimal) (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](docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).



2564
2565
2566
 
# File 'lib/stripe/resources/charge.rb', line 2564

def amount
  @amount
end

#amount_captured ⇒ Object (readonly)

Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).



2566
2567
2568
 
# File 'lib/stripe/resources/charge.rb', line 2566

def amount_captured
  @amount_captured
end

#amount_refunded ⇒ Object (readonly)

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



2568
2569
2570
 
# File 'lib/stripe/resources/charge.rb', line 2568

def amount_refunded
  @amount_refunded
end

#application ⇒ Object (readonly)

ID of the Connect application that created the charge.



2570
2571
2572
 
# File 'lib/stripe/resources/charge.rb', line 2570

def application
  @application
end

#application_fee ⇒ Object (readonly)

The application fee (if any) for the charge. [See the Connect documentation](docs.stripe.com/connect/direct-charges#collect-fees) for details.



2572
2573
2574
 
# File 'lib/stripe/resources/charge.rb', line 2572

def application_fee
  @application_fee
end

#application_fee_amount ⇒ Object (readonly)

The amount of the application fee (if any) requested for the charge. [See the Connect documentation](docs.stripe.com/connect/direct-charges#collect-fees) for details.



2574
2575
2576
 
# File 'lib/stripe/resources/charge.rb', line 2574

def application_fee_amount
  @application_fee_amount
end

#authorization_code ⇒ Object (readonly)

Authorization code on the charge.



2576
2577
2578
 
# File 'lib/stripe/resources/charge.rb', line 2576

def authorization_code
  @authorization_code
end

#balance_transaction ⇒ Object (readonly)

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



2578
2579
2580
 
# File 'lib/stripe/resources/charge.rb', line 2578

def balance_transaction
  @balance_transaction
end

#billing_details ⇒ Object (readonly)

Attribute for field billing_details



2580
2581
2582
 
# File 'lib/stripe/resources/charge.rb', line 2580

def billing_details
  @billing_details
end

#calculated_statement_descriptor ⇒ Object (readonly)

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.



2582
2583
2584
 
# File 'lib/stripe/resources/charge.rb', line 2582

def calculated_statement_descriptor
  @calculated_statement_descriptor
end

#captured ⇒ Object (readonly)

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



2584
2585
2586
 
# File 'lib/stripe/resources/charge.rb', line 2584

def captured
  @captured
end

#created ⇒ Object (readonly)

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



2586
2587
2588
 
# File 'lib/stripe/resources/charge.rb', line 2586

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



2588
2589
2590
 
# File 'lib/stripe/resources/charge.rb', line 2588

def currency
  @currency
end

#customer ⇒ Object (readonly)

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



2590
2591
2592
 
# File 'lib/stripe/resources/charge.rb', line 2590

def customer
  @customer
end

#description ⇒ Object (readonly)

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



2592
2593
2594
 
# File 'lib/stripe/resources/charge.rb', line 2592

def description
  @description
end

#disputed ⇒ Object (readonly)

Whether the charge has been disputed.



2594
2595
2596
 
# File 'lib/stripe/resources/charge.rb', line 2594

def disputed
  @disputed
end

#failure_balance_transaction ⇒ Object (readonly)

ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.



2596
2597
2598
 
# File 'lib/stripe/resources/charge.rb', line 2596

def failure_balance_transaction
  @failure_balance_transaction
end

#failure_code ⇒ Object (readonly)

Error code explaining reason for charge failure if available (see [the errors section](docs.stripe.com/error-codes) for a list of codes).



2598
2599
2600
 
# File 'lib/stripe/resources/charge.rb', line 2598

def failure_code
  @failure_code
end

#failure_message ⇒ Object (readonly)

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



2600
2601
2602
 
# File 'lib/stripe/resources/charge.rb', line 2600

def failure_message
  @failure_message
end

#fraud_details ⇒ Object (readonly)

Information on fraud assessments for the charge.



2602
2603
2604
 
# File 'lib/stripe/resources/charge.rb', line 2602

def fraud_details
  @fraud_details
end

#id ⇒ Object (readonly)

Unique identifier for the object.



2604
2605
2606
 
# File 'lib/stripe/resources/charge.rb', line 2604

def id
  @id
end

#level3 ⇒ Object (readonly)

Attribute for field level3



2606
2607
2608
 
# File 'lib/stripe/resources/charge.rb', line 2606

def level3
  @level3
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is ‘true`. If the object exists in test mode, the value is `false`.



2608
2609
2610
 
# File 'lib/stripe/resources/charge.rb', line 2608

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



2610
2611
2612
 
# File 'lib/stripe/resources/charge.rb', line 2610

def metadata
  @metadata
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



2612
2613
2614
 
# File 'lib/stripe/resources/charge.rb', line 2612

def object
  @object
end

#on_behalf_of ⇒ Object (readonly)

The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](docs.stripe.com/connect/separate-charges-and-transfers) for details.



2614
2615
2616
 
# File 'lib/stripe/resources/charge.rb', line 2614

def on_behalf_of
  @on_behalf_of
end

#outcome ⇒ Object (readonly)

Details about whether the payment was accepted, and why. See [understanding declines](docs.stripe.com/declines) for details.



2616
2617
2618
 
# File 'lib/stripe/resources/charge.rb', line 2616

def outcome
  @outcome
end

‘true` if the charge succeeded, or was successfully authorized for later capture.



2618
2619
2620
 
# File 'lib/stripe/resources/charge.rb', line 2618

def paid
  @paid
end

#payment_intent ⇒ Object (readonly)

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



2620
2621
2622
 
# File 'lib/stripe/resources/charge.rb', line 2620

def payment_intent
  @payment_intent
end

#payment_method ⇒ Object (readonly)

ID of the payment method used in this charge.



2622
2623
2624
 
# File 'lib/stripe/resources/charge.rb', line 2622

def payment_method
  @payment_method
end

#payment_method_details ⇒ Object (readonly)

Details about the payment method at the time of the transaction.



2624
2625
2626
 
# File 'lib/stripe/resources/charge.rb', line 2624

def payment_method_details
  @payment_method_details
end

#presentment_details ⇒ Object (readonly)

Attribute for field presentment_details



2626
2627
2628
 
# File 'lib/stripe/resources/charge.rb', line 2626

def presentment_details
  @presentment_details
end

#radar_options ⇒ Object (readonly)

Options to configure Radar. See [Radar Session](docs.stripe.com/radar/radar-session) for more information.



2628
2629
2630
 
# File 'lib/stripe/resources/charge.rb', line 2628

def radar_options
  @radar_options
end

#receipt_email ⇒ Object (readonly)

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



2630
2631
2632
 
# File 'lib/stripe/resources/charge.rb', line 2630

def receipt_email
  @receipt_email
end

#receipt_number ⇒ Object (readonly)

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.



2632
2633
2634
 
# File 'lib/stripe/resources/charge.rb', line 2632

def receipt_number
  @receipt_number
end

#receipt_url ⇒ Object (readonly)

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.



2634
2635
2636
 
# File 'lib/stripe/resources/charge.rb', line 2634

def receipt_url
  @receipt_url
end

#refunded ⇒ Object (readonly)

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



2636
2637
2638
 
# File 'lib/stripe/resources/charge.rb', line 2636

def refunded
  @refunded
end

#refunds ⇒ Object (readonly)

A list of refunds that have been applied to the charge.



2638
2639
2640
 
# File 'lib/stripe/resources/charge.rb', line 2638

def refunds
  @refunds
end

#review ⇒ Object (readonly)

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



2640
2641
2642
 
# File 'lib/stripe/resources/charge.rb', line 2640

def review
  @review
end

#shipping ⇒ Object (readonly)

Shipping information for the charge.



2642
2643
2644
 
# File 'lib/stripe/resources/charge.rb', line 2642

def shipping
  @shipping
end

#source ⇒ Object (readonly)

This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to ‘payment_method` or `payment_method_details` instead.



2644
2645
2646
 
# File 'lib/stripe/resources/charge.rb', line 2644

def source
  @source
end

#source_transfer ⇒ Object (readonly)

The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](docs.stripe.com/connect/destination-charges) for details.



2646
2647
2648
 
# File 'lib/stripe/resources/charge.rb', line 2646

def source_transfer
  @source_transfer
end

#statement_descriptor ⇒ Object (readonly)

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](docs.stripe.com/get-started/account/statement-descriptors).

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.



2650
2651
2652
 
# File 'lib/stripe/resources/charge.rb', line 2650

def statement_descriptor
  @statement_descriptor
end

#statement_descriptor_suffix ⇒ Object (readonly)

Provides information about a card charge. Concatenated to the account’s [statement descriptor prefix](docs.stripe.com/get-started/account/statement-descriptors#static) 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.



2652
2653
2654
 
# File 'lib/stripe/resources/charge.rb', line 2652

def statement_descriptor_suffix
  @statement_descriptor_suffix
end

#status ⇒ Object (readonly)

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



2654
2655
2656
 
# File 'lib/stripe/resources/charge.rb', line 2654

def status
  @status
end

#transfer ⇒ Object (readonly)

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



2656
2657
2658
 
# File 'lib/stripe/resources/charge.rb', line 2656

def transfer
  @transfer
end

#transfer_data ⇒ Object (readonly)

An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](docs.stripe.com/connect/destination-charges) for details.



2658
2659
2660
 
# File 'lib/stripe/resources/charge.rb', line 2658

def transfer_data
  @transfer_data
end

#transfer_group ⇒ Object (readonly)

A string that identifies this transaction as part of a group. See the [Connect documentation](docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.



2660
2661
2662
 
# File 'lib/stripe/resources/charge.rb', line 2660

def transfer_group
  @transfer_group
end

Class Method Details

.capture(charge, params = {}, opts = {}) ⇒ Object

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

Uncaptured payments expire a set number of days after they are created ([7 by default](docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.

Don’t use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](docs.stripe.com/docs/api/payment_intents/capture).



2681
2682
2683
2684
2685
2686
2687
2688
 
# File 'lib/stripe/resources/charge.rb', line 2681

def self.capture(charge, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(charge) }),
    params: params,
    opts: opts
  )
end

.create(params = {}, opts = {}) ⇒ Object

This method is no longer recommended—use the [Payment Intents API](docs.stripe.com/docs/api/payment_intents) to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge object used to request payment.



2693
2694
2695
 
# File 'lib/stripe/resources/charge.rb', line 2693

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/charges", params: params, opts: opts)
end

.field_remappings ⇒ Object 



2734
2735
2736
 
# File 'lib/stripe/resources/charge.rb', line 2734

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
 
# File 'lib/stripe/resources/charge.rb', line 2720

def self.inner_class_types
  @inner_class_types = {
    billing_details: BillingDetails,
    fraud_details: FraudDetails,
    level3: Level3,
    outcome: Outcome,
    payment_method_details: PaymentMethodDetails,
    presentment_details: PresentmentDetails,
    radar_options: RadarOptions,
    shipping: Shipping,
    transfer_data: TransferData,
  }
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.



2698
2699
2700
 
# File 'lib/stripe/resources/charge.rb', line 2698

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/charges", params: params, opts: opts)
end

.object_name ⇒ Object 



16
17
18
 
# File 'lib/stripe/resources/charge.rb', line 16

def self.object_name
  "charge"
end

.search(params = {}, opts = {}) ⇒ Object 



2702
2703
2704
 
# File 'lib/stripe/resources/charge.rb', line 2702

def self.search(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/charges/search", params: params, opts: opts)
end

.search_auto_paging_each(params = {}, opts = {}, &blk) ⇒ Object 



2706
2707
2708
 
# File 'lib/stripe/resources/charge.rb', line 2706

def self.search_auto_paging_each(params = {}, opts = {}, &blk)
  search(params, opts).auto_paging_each(&blk)
end

.update(charge, params = {}, opts = {}) ⇒ Object

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.



2711
2712
2713
2714
2715
2716
2717
2718
 
# File 'lib/stripe/resources/charge.rb', line 2711

def self.update(charge, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/charges/%<charge>s", { charge: CGI.escape(charge) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#capture(params = {}, opts = {}) ⇒ Object

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

Uncaptured payments expire a set number of days after they are created ([7 by default](docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.

Don’t use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](docs.stripe.com/docs/api/payment_intents/capture).



2667
2668
2669
2670
2671
2672
2673
2674
 
# File 'lib/stripe/resources/charge.rb', line 2667

def capture(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end