get/v1/payment_intents

List all PaymentIntents

Returns a list of PaymentIntents.

Query parameters

Name	Description
created	A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
customer	Only return PaymentIntents for the customer that this customer ID specifies.
customer_account	Only return PaymentIntents for the account representing the customer that this ID specifies.
ending_before	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	Specifies which fields in the response should be expanded.
limit	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request body

object (no properties in spec)

Response

Field Type Description

data*

array<payment_intent>

array item fields

Field Type Description

amount

integer

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_capturable

integer

Amount that can be captured from this PaymentIntent.

amount_details payment_flows_amount_details | payment_flows_amount_details_client

amount_received

integer

Amount that this PaymentIntent collects.

application

string | application

ID of the Connect application that created the PaymentIntent.

application_fee_amount

integer

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.

automatic_payment_methods

payment_flows_automatic_payment_methods_payment_intent

Settings to configure compatible payment methods from the Stripe Dashboard

canceled_at

integer (unix-time)

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

cancellation_reason

string

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

string

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

client_secret

string

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

string

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

created*

integer (unix-time)

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

currency

string (currency)

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

customer

string | customer | deleted_customer

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 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 payment method representing the card is created and attached to the Customer instead.

customer_account

string

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.

description

string

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

excluded_payment_method_types

array<string>

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

hooks

payment_flows_payment_intent_async_workflows

1 nested field

Field	Type	Description
inputs	payment_flows_payment_intent_async_workflows_resource_inputs

id*

string

Unique identifier for the object.

last_payment_error

api_errors

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

latest_charge

string | charge

ID of the latest Charge object created by this PaymentIntent. This property is null until PaymentIntent confirmation is attempted.

livemode*

boolean

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

managed_payments

smor_resource_managed_payments

Settings for Managed Payments.

metadata

object

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.

next_action

payment_intent_next_action

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.

object*

string

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

on_behalf_of

string | account

You can specify the settlement merchant as the connected account using the on_behalf_of attribute on the charge. See the PaymentIntents use case for connected accounts for details.

payment_details

payment_flows_payment_details

2 nested fields

Field	Type	Description
customer_reference	string	A unique value to identify the customer. This field is available only for card payments. This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
order_reference	string	A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.

payment_method

string | payment_method

ID of the payment method used in this PaymentIntent.

has_more*

boolean

True if this list has another page of items after this one that can be fetched.

object*

string

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

url*

string

The URL where this list can be accessed.