Retrieve a PaymentIntent

Changed on

Retrieves the details of a PaymentIntent that has previously been created.

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

get/v1/payment_intents/{intent}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/payment_intents/{intent}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

intentstring required

Query parameters

client_secretstring

The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

allowed_payment_method_typesstring[] nullable

The list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the payment_method_types field of the response, based on the other PaymentIntent parameters, such as currency, amount, and customer.

amountinteger

Amount intended to be collected by this PaymentIntent. 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).

amount_capturableinteger

Amount that can be captured from this PaymentIntent.

amount_receivedinteger

Amount that this PaymentIntent collects.

application_fee_amountinteger nullable

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.

canceled_atinteger nullable

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

cancellation_reason'abandoned' | 'automatic' | 'duplicate' | 'expired' | 'failed_invoice' | 'fraudulent' | 'requested_by_customer' | 'void_invoice' nullable

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

capture_method'automatic' | 'automatic_async' | 'manual'

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

client_secretstring nullable

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 and learn about how client_secret should be handled.

confirmation_method'automatic' | 'manual'

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

createdinteger required

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

currencystring currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer_accountstring nullable

ID of the Account representing the customer that this PaymentIntent belongs to, if one exists.

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

If setup_future_usage is set and this PaymentIntent's payment method is not card_present, then the payment method attaches to the Account 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 payment method representing the card is created and attached to the Account instead.

descriptionstring nullable

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

excluded_payment_method_typesstring[] nullable

The list of payment method types to exclude from use with this payment.

idstring required

Unique identifier for the object.

livemodeboolean required

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

metadataobject

Set of key-value pairs 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.

object'payment_intent' required

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

payment_method_typesstring[]

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.

receipt_emailstring nullable

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.

setup_future_usage'off_session' | 'on_session' nullable

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

statement_descriptorstring nullable

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.

Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

statement_descriptor_suffixstring nullable

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.

status'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded' required

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.

transfer_groupstring nullable

A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts.

Changes

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.