Class: Stripe::PaymentIntent

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

Overview

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

A PaymentIntent transitions through [multiple statuses](stripe.com/docs/payments/intents#intent-statuses) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

Related guide: [Payment Intents API](stripe.com/docs/payments/payment-intents)

Defined Under Namespace

Classes: AmountDetails, ApplyCustomerBalanceParams, AutomaticPaymentMethods, CancelParams, CaptureParams, ConfirmParams, CreateParams, IncrementAuthorizationParams, LastPaymentError, ListParams, NextAction, PaymentMethodConfigurationDetails, PaymentMethodOptions, PresentmentDetails, Processing, SearchParams, Shipping, TransferData, UpdateParams, VerifyMicrodepositsParams

Constant Summary collapse

OBJECT_NAME = 
"payment_intent"

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::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

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #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

#amount ⇒ Object (readonly)

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](stripe.com/docs/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](stripe.com/docs/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).



8645
8646
8647
 
# File 'lib/stripe/resources/payment_intent.rb', line 8645

def amount
  @amount
end

#amount_capturable ⇒ Object (readonly)

Amount that can be captured from this PaymentIntent.



8647
8648
8649
 
# File 'lib/stripe/resources/payment_intent.rb', line 8647

def amount_capturable
  @amount_capturable
end

#amount_details ⇒ Object (readonly)

Attribute for field amount_details



8649
8650
8651
 
# File 'lib/stripe/resources/payment_intent.rb', line 8649

def amount_details
  @amount_details
end

#amount_received ⇒ Object (readonly)

Amount that this PaymentIntent collects.



8651
8652
8653
 
# File 'lib/stripe/resources/payment_intent.rb', line 8651

def amount_received
  @amount_received
end

#application ⇒ Object (readonly)

ID of the Connect application that created the PaymentIntent.



8653
8654
8655
 
# File 'lib/stripe/resources/payment_intent.rb', line 8653

def application
  @application
end

#application_fee_amount ⇒ Object (readonly)

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](stripe.com/docs/payments/connected-accounts).



8655
8656
8657
 
# File 'lib/stripe/resources/payment_intent.rb', line 8655

def application_fee_amount
  @application_fee_amount
end

#automatic_payment_methods ⇒ Object (readonly)

Settings to configure compatible payment methods from the [Stripe Dashboard](dashboard.stripe.com/settings/payment_methods)



8657
8658
8659
 
# File 'lib/stripe/resources/payment_intent.rb', line 8657

def automatic_payment_methods
  @automatic_payment_methods
end

#canceled_at ⇒ Object (readonly)

Populated when ‘status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.



8659
8660
8661
 
# File 'lib/stripe/resources/payment_intent.rb', line 8659

def canceled_at
  @canceled_at
end

#cancellation_reason ⇒ Object (readonly)

Reason for cancellation of this PaymentIntent, either user-provided (‘duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`).



8661
8662
8663
 
# File 'lib/stripe/resources/payment_intent.rb', line 8661

def cancellation_reason
  @cancellation_reason
end

#capture_method ⇒ Object (readonly)

Controls when the funds will be captured from the customer’s account.



8663
8664
8665
 
# File 'lib/stripe/resources/payment_intent.rb', line 8663

def capture_method
  @capture_method
end

#client_secret ⇒ Object (readonly)

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

Refer to our docs to [accept a payment](stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how ‘client_secret` should be handled.



8669
8670
8671
 
# File 'lib/stripe/resources/payment_intent.rb', line 8669

def client_secret
  @client_secret
end

#confirmation_method ⇒ Object (readonly)

Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.



8671
8672
8673
 
# File 'lib/stripe/resources/payment_intent.rb', line 8671

def confirmation_method
  @confirmation_method
end

#created ⇒ Object (readonly)

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



8673
8674
8675
 
# File 'lib/stripe/resources/payment_intent.rb', line 8673

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).



8675
8676
8677
 
# File 'lib/stripe/resources/payment_intent.rb', line 8675

def currency
  @currency
end

#customer ⇒ Object (readonly)

ID of the Customer this PaymentIntent belongs to, if one exists.

Payment methods attached to other Customers cannot be used with this PaymentIntent.

If [setup_future_usage](stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent’s payment method is not ‘card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn’t a digital wallet, then a [generated_card](docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.



8681
8682
8683
 
# File 'lib/stripe/resources/payment_intent.rb', line 8681

def customer
  @customer
end

#description ⇒ Object (readonly)

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



8683
8684
8685
 
# File 'lib/stripe/resources/payment_intent.rb', line 8683

def description
  @description
end

#id ⇒ Object (readonly)

Unique identifier for the object.



8685
8686
8687
 
# File 'lib/stripe/resources/payment_intent.rb', line 8685

def id
  @id
end

#last_payment_error ⇒ Object (readonly)

The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.



8687
8688
8689
 
# File 'lib/stripe/resources/payment_intent.rb', line 8687

def last_payment_error
  @last_payment_error
end

#latest_charge ⇒ Object (readonly)

ID of the latest [Charge object](stripe.com/docs/api/charges) created by this PaymentIntent. This property is ‘null` until PaymentIntent confirmation is attempted.



8689
8690
8691
 
# File 'lib/stripe/resources/payment_intent.rb', line 8689

def latest_charge
  @latest_charge
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



8691
8692
8693
 
# File 'lib/stripe/resources/payment_intent.rb', line 8691

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

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



8693
8694
8695
 
# File 'lib/stripe/resources/payment_intent.rb', line 8693

def metadata
  @metadata
end

#next_action ⇒ Object (readonly)

If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.



8695
8696
8697
 
# File 'lib/stripe/resources/payment_intent.rb', line 8695

def next_action
  @next_action
end

#object ⇒ Object (readonly)

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



8697
8698
8699
 
# File 'lib/stripe/resources/payment_intent.rb', line 8697

def object
  @object
end

#on_behalf_of ⇒ Object (readonly)

The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](stripe.com/docs/payments/connected-accounts) for details.



8699
8700
8701
 
# File 'lib/stripe/resources/payment_intent.rb', line 8699

def on_behalf_of
  @on_behalf_of
end

#payment_method ⇒ Object (readonly)

ID of the payment method used in this PaymentIntent.



8701
8702
8703
 
# File 'lib/stripe/resources/payment_intent.rb', line 8701

def payment_method
  @payment_method
end

#payment_method_configuration_details ⇒ Object (readonly)

Information about the [payment method configuration](stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.



8703
8704
8705
 
# File 'lib/stripe/resources/payment_intent.rb', line 8703

def payment_method_configuration_details
  @payment_method_configuration_details
end

#payment_method_options ⇒ Object (readonly)

Payment-method-specific configuration for this PaymentIntent.



8705
8706
8707
 
# File 'lib/stripe/resources/payment_intent.rb', line 8705

def payment_method_options
  @payment_method_options
end

#payment_method_types ⇒ Object (readonly)

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](docs.stripe.com/api/payment_methods/object#payment_method_object-type).



8707
8708
8709
 
# File 'lib/stripe/resources/payment_intent.rb', line 8707

def payment_method_types
  @payment_method_types
end

#presentment_details ⇒ Object (readonly)

Attribute for field presentment_details



8709
8710
8711
 
# File 'lib/stripe/resources/payment_intent.rb', line 8709

def presentment_details
  @presentment_details
end

#processing ⇒ Object (readonly)

If present, this property tells you about the processing state of the payment.



8711
8712
8713
 
# File 'lib/stripe/resources/payment_intent.rb', line 8711

def processing
  @processing
end

#receipt_email ⇒ Object (readonly)

Email address that the receipt for the resulting payment will be sent to. If ‘receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](dashboard.stripe.com/account/emails).



8713
8714
8715
 
# File 'lib/stripe/resources/payment_intent.rb', line 8713

def receipt_email
  @receipt_email
end

#review ⇒ Object (readonly)

ID of the review associated with this PaymentIntent, if any.



8715
8716
8717
 
# File 'lib/stripe/resources/payment_intent.rb', line 8715

def review
  @review
end

#setup_future_usage ⇒ Object (readonly)

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.

If the payment method is ‘card_present` and isn’t a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.

When processing card payments, Stripe uses ‘setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).



8723
8724
8725
 
# File 'lib/stripe/resources/payment_intent.rb', line 8723

def setup_future_usage
  @setup_future_usage
end

#shipping ⇒ Object (readonly)

Shipping information for this PaymentIntent.



8725
8726
8727
 
# File 'lib/stripe/resources/payment_intent.rb', line 8725

def shipping
  @shipping
end

#source ⇒ Object (readonly)

This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied.



8727
8728
8729
 
# File 'lib/stripe/resources/payment_intent.rb', line 8727

def source
  @source
end

#statement_descriptor ⇒ Object (readonly)

Text that appears on the customer’s statement as the statement descriptor for a non-card charge. 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).

Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.



8731
8732
8733
 
# File 'lib/stripe/resources/payment_intent.rb', line 8731

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.



8733
8734
8735
 
# File 'lib/stripe/resources/payment_intent.rb', line 8733

def statement_descriptor_suffix
  @statement_descriptor_suffix
end

#status ⇒ Object (readonly)

Status of this PaymentIntent, one of ‘requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](stripe.com/docs/payments/intents#intent-statuses).



8735
8736
8737
 
# File 'lib/stripe/resources/payment_intent.rb', line 8735

def status
  @status
end

#transfer_data ⇒ Object (readonly)

The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](stripe.com/docs/payments/connected-accounts).



8737
8738
8739
 
# File 'lib/stripe/resources/payment_intent.rb', line 8737

def transfer_data
  @transfer_data
end

#transfer_group ⇒ Object (readonly)

A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](stripe.com/docs/connect/separate-charges-and-transfers).



8739
8740
8741
 
# File 'lib/stripe/resources/payment_intent.rb', line 8739

def transfer_group
  @transfer_group
end

Class Method Details

.apply_customer_balance(intent, params = {}, opts = {}) ⇒ Object

Manually reconcile the remaining amount for a customer_balance PaymentIntent.



8752
8753
8754
8755
8756
8757
8758
8759
 
# File 'lib/stripe/resources/payment_intent.rb', line 8752

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

.cancel(intent, params = {}, opts = {}) ⇒ Object

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](stripe.com/docs/payments/intents), processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](stripe.com/docs/api/checkout/sessions/expire) instead.



8780
8781
8782
8783
8784
8785
8786
8787
 
# File 'lib/stripe/resources/payment_intent.rb', line 8780

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

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

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about [separate authorization and capture](stripe.com/docs/payments/capture-later).



8808
8809
8810
8811
8812
8813
8814
8815
 
# File 'lib/stripe/resources/payment_intent.rb', line 8808

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

.confirm(intent, params = {}, opts = {}) ⇒ Object

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our [client SDKs](stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) and the PaymentIntent’s [client_secret](stripe.com/docs/api#payment_intent_object-client_secret). After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the canceled state.



8876
8877
8878
8879
8880
8881
8882
8883
 
# File 'lib/stripe/resources/payment_intent.rb', line 8876

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

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

Creates a PaymentIntent object.

After the PaymentIntent is created, attach a payment method and [confirm](stripe.com/docs/api/payment_intents/confirm) to continue the payment. Learn more about <a href=“/docs/payments/payment-intents”>the available payment flows with the Payment Intents API.

When you use confirm=true during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the [confirm API](stripe.com/docs/api/payment_intents/confirm) when you supply confirm=true.



8895
8896
8897
 
# File 'lib/stripe/resources/payment_intent.rb', line 8895

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

.increment_authorization(intent, params = {}, opts = {}) ⇒ Object

Perform an incremental authorization on an eligible [PaymentIntent](stripe.com/docs/api/payment_intents/object). To be eligible, the PaymentIntent’s status must be requires_capture and [incremental_authorization_supported](stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) must be true.

Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent object returns with the updated [amount](stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). If the incremental authorization fails, a [card_declined](stripe.com/docs/error-codes#card-declined) error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about [incremental authorizations](stripe.com/docs/terminal/features/incremental-authorizations).



8956
8957
8958
8959
8960
8961
8962
8963
 
# File 'lib/stripe/resources/payment_intent.rb', line 8956

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

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

Returns a list of PaymentIntents.



8966
8967
8968
 
# File 'lib/stripe/resources/payment_intent.rb', line 8966

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

.object_name ⇒ Object 



23
24
25
 
# File 'lib/stripe/resources/payment_intent.rb', line 23

def self.object_name
  "payment_intent"
end

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



8970
8971
8972
8973
8974
8975
8976
8977
 
# File 'lib/stripe/resources/payment_intent.rb', line 8970

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

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



8979
8980
8981
 
# File 'lib/stripe/resources/payment_intent.rb', line 8979

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

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

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the [confirm API](stripe.com/docs/api/payment_intents/confirm) instead.



8990
8991
8992
8993
8994
8995
8996
8997
 
# File 'lib/stripe/resources/payment_intent.rb', line 8990

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

.verify_microdeposits(intent, params = {}, opts = {}) ⇒ Object

Verifies microdeposits on a PaymentIntent object.



9010
9011
9012
9013
9014
9015
9016
9017
 
# File 'lib/stripe/resources/payment_intent.rb', line 9010

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

Instance Method Details

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

Manually reconcile the remaining amount for a customer_balance PaymentIntent.



8742
8743
8744
8745
8746
8747
8748
8749
 
# File 'lib/stripe/resources/payment_intent.rb', line 8742

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

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

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](stripe.com/docs/payments/intents), processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](stripe.com/docs/api/checkout/sessions/expire) instead.



8766
8767
8768
8769
8770
8771
8772
8773
 
# File 'lib/stripe/resources/payment_intent.rb', line 8766

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

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

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about [separate authorization and capture](stripe.com/docs/payments/capture-later).



8794
8795
8796
8797
8798
8799
8800
8801
 
# File 'lib/stripe/resources/payment_intent.rb', line 8794

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

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

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our [client SDKs](stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) and the PaymentIntent’s [client_secret](stripe.com/docs/api#payment_intent_object-client_secret). After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the canceled state.



8842
8843
8844
8845
8846
8847
8848
8849
 
# File 'lib/stripe/resources/payment_intent.rb', line 8842

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

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

Perform an incremental authorization on an eligible [PaymentIntent](stripe.com/docs/api/payment_intents/object). To be eligible, the PaymentIntent’s status must be requires_capture and [incremental_authorization_supported](stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) must be true.

Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent object returns with the updated [amount](stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). If the incremental authorization fails, a [card_declined](stripe.com/docs/error-codes#card-declined) error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about [incremental authorizations](stripe.com/docs/terminal/features/incremental-authorizations).



8923
8924
8925
8926
8927
8928
8929
8930
 
# File 'lib/stripe/resources/payment_intent.rb', line 8923

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

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

Verifies microdeposits on a PaymentIntent object.



9000
9001
9002
9003
9004
9005
9006
9007
 
# File 'lib/stripe/resources/payment_intent.rb', line 9000

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