[metadata]
viewport: width=device-width, initial-scale=1.0, viewport-fit=cover

[document-links]
/api
Account Links v2: https://docs.stripe.com/api/v2/core/account-links
Account Links: https://docs.stripe.com/api/account_links
Account Sessions: https://docs.stripe.com/api/account_sessions
Account Tokens v2: https://docs.stripe.com/api/v2/core/account-tokens
Accounts v2: https://docs.stripe.com/api/v2/core/accounts
Accounts: https://docs.stripe.com/api/accounts
Alerts: https://docs.stripe.com/api/billing/alert
Application Fee Refunds: https://docs.stripe.com/api/fee_refunds
Application Fees: https://docs.stripe.com/api/application_fees
Authentication: https://docs.stripe.com/api/authentication
Balance Settings: https://docs.stripe.com/api/balance-settings
Balance Transactions: https://docs.stripe.com/api/balance_transactions
Balances: https://docs.stripe.com/api/balance
Bank Accounts: https://docs.stripe.com/api/customer_bank_accounts
Cancel a PaymentIntent: https://docs.stripe.com/api/payment_intents/cancel
Capabilities: https://docs.stripe.com/api/capabilities
Capture a PaymentIntent: https://docs.stripe.com/api/payment_intents/capture
Cards: https://docs.stripe.com/api/cards
Cash Balance Transactions: https://docs.stripe.com/api/cash_balance_transactions
Cash Balances: https://docs.stripe.com/api/cash_balance
Charges: https://docs.stripe.com/api/charges
Checkout Sessions: https://docs.stripe.com/api/checkout/sessions
Confirm API: /api/payment_intents/confirm
Confirm a PaymentIntent: https://docs.stripe.com/api/payment_intents/confirm
Confirmation Tokens: https://docs.stripe.com/api/confirmation_tokens
Connected Accounts: https://docs.stripe.com/api/connected-accounts
Contact Sales: https://stripe.com/contact/sales
Contact Support: https://support.stripe.com/
Country Specs: https://docs.stripe.com/api/country_specs
Coupons: https://docs.stripe.com/api/coupons
Create a PaymentIntent: /api/payment_intents/create
Create a PaymentIntent: https://docs.stripe.com/api/payment_intents/create
Credit Balance Summaries: https://docs.stripe.com/api/billing/credit-balance-summary
Credit Balance Transactions: https://docs.stripe.com/api/billing/credit-balance-transaction
Credit Grants: https://docs.stripe.com/api/billing/credit-grant
Credit Notes: https://docs.stripe.com/api/credit_notes
Customer Balance Transactions: https://docs.stripe.com/api/customer_balance_transactions
Customer Portal Configurations: https://docs.stripe.com/api/customer_portal/configurations
Customer Portal Sessions: https://docs.stripe.com/api/customer_portal/sessions
Customer Sessions: https://docs.stripe.com/api/customer_sessions
Customers: https://docs.stripe.com/api/customers
Discord: https://stripe.com/go/developer-chat
Discounts: https://docs.stripe.com/api/discounts
Disputes: https://docs.stripe.com/api/disputes
Docs: /
Enums: https://docs.stripe.com/api/enums
Errors: https://docs.stripe.com/api/errors
Event Destinations v2: https://docs.stripe.com/api/v2/core/event-destinations
Events v2: https://docs.stripe.com/api/v2/core/events
Events: https://docs.stripe.com/api/events
Expanding Responses: https://docs.stripe.com/api/expanding_objects
External Account Cards: https://docs.stripe.com/api/external_account_cards
External Bank Accounts: https://docs.stripe.com/api/external_accounts
File Links: https://docs.stripe.com/api/file_links
Files: https://docs.stripe.com/api/files
Financing Offers: https://docs.stripe.com/api/capital/financing_offers
Financing Summaries: https://docs.stripe.com/api/capital/financing_summary
ISO currency code: https://www.iso.org/iso-4217-currency-codes.html
Idempotent requests: https://docs.stripe.com/api/idempotent_requests
Include-dependent response values (API v2): https://docs.stripe.com/api/include_dependent_response_values
Increment an authorization: https://docs.stripe.com/api/payment_intents/increment_authorization
Introduction: https://docs.stripe.com/api
Invoice Items: https://docs.stripe.com/api/invoiceitems
Invoice Line Items: https://docs.stripe.com/api/invoice-line-item
Invoice Payments: https://docs.stripe.com/api/invoice-payment
Invoice Rendering Templates: https://docs.stripe.com/api/invoice-rendering-template
Invoices: https://docs.stripe.com/api/invoices
List all PaymentIntent LineItems: https://docs.stripe.com/api/payment_intents/amount_details_line_items
List all PaymentIntents: https://docs.stripe.com/api/payment_intents/list
Login Links: https://docs.stripe.com/api/accounts/login_link
Mandates: https://docs.stripe.com/api/mandates
Markdoc: https://markdoc.dev
Metadata: https://docs.stripe.com/api/metadata
Meter Event Adjustment: https://docs.stripe.com/api/billing/meter-event-adjustment
Meter Event Adjustments v2: https://docs.stripe.com/api/v2/billing/meter-event-adjustments
Meter Event Streams v2: https://docs.stripe.com/api/v2/meter-event-streams
Meter Event Summary: https://docs.stripe.com/api/billing/meter-event-summary
Meter Events v2: https://docs.stripe.com/api/v2/meter-events
Meter Events: https://docs.stripe.com/api/billing/meter-event
Meters: https://docs.stripe.com/api/billing/meter
Pagination: https://docs.stripe.com/api/pagination
Payment Intents: https://docs.stripe.com/api/payment_intents
Payment Links: https://docs.stripe.com/api/payment-link
Payment Method Configurations: https://docs.stripe.com/api/payment_method_configurations
Payment Method Domains: https://docs.stripe.com/api/payment_method_domains
Payment Methods: https://docs.stripe.com/api/payment_methods
Payouts: https://docs.stripe.com/api/payouts
Person Tokens v2: https://docs.stripe.com/api/v2/core/person-tokens
Persons v2: https://docs.stripe.com/api/v2/core/persons
Persons: https://docs.stripe.com/api/persons
Plans: https://docs.stripe.com/api/plans
Prices: https://docs.stripe.com/api/prices
Products: https://docs.stripe.com/api/products
Promotion Codes: https://docs.stripe.com/api/promotion_codes
Quotes: https://docs.stripe.com/api/quotes
Read llms.txt: /llms.txt
Reconcile a customer_balance PaymentIntent: https://docs.stripe.com/api/payment_intents/apply_customer_balance
Refunds: https://docs.stripe.com/api/refunds
Request IDs: https://docs.stripe.com/api/request_ids
Retrieve a PaymentIntent: /api/payment_intents/retrieve
Retrieve a PaymentIntent: https://docs.stripe.com/api/payment_intents/retrieve
SCA: /strong-customer-authentication
Search PaymentIntents: https://docs.stripe.com/api/payment_intents/search
Secrets: https://docs.stripe.com/api/secret_management
Setup Attempts: https://docs.stripe.com/api/setup_attempts
Setup Intents: https://docs.stripe.com/api/setup_intents
Shared Payment Granted Tokens: https://docs.stripe.com/api/shared-payment/granted-token
Shared Payment Issued Tokens: https://docs.stripe.com/api/shared-payment/issued-token
Shipping Rates: https://docs.stripe.com/api/shipping_rates
Sign in →: https://dashboard.stripe.com/login?redirect=https%3A%2F%2Fdocs.stripe.com%2Fapi%2Fpayment_intents%2Fcreate
Sources: https://docs.stripe.com/api/sources
Stripe Balance Debit Agreements: https://docs.stripe.com/api/stripe_balance_debit_agreements
Subscription Items: https://docs.stripe.com/api/subscription_items
Subscription Schedules: https://docs.stripe.com/api/subscription_schedules
Subscriptions: https://docs.stripe.com/api/subscriptions
Support: https://support.stripe.com
Tax Codes: https://docs.stripe.com/api/tax_codes
Tax IDs: https://docs.stripe.com/api/tax_ids
Tax Rates: https://docs.stripe.com/api/tax_rates
Test Clocks: https://docs.stripe.com/api/test_clocks
The PaymentIntent object: https://docs.stripe.com/api/payment_intents/object
Tokens: https://docs.stripe.com/api/tokens
Top-ups: https://docs.stripe.com/api/topups
Transfer Reversals: https://docs.stripe.com/api/transfer_reversals
Transfers: https://docs.stripe.com/api/transfers
Update a PaymentIntent: /api/payment_intents/update
Update a PaymentIntent: https://docs.stripe.com/api/payment_intents/update
Verify microdeposits on a PaymentIntent: https://docs.stripe.com/api/payment_intents/verify_microdeposits
Versioning: https://docs.stripe.com/api/versioning
attach the payment method: /payments/save-during-payment
attach: /api/payment_methods/attach
changelog: /changelog
charge them later: /payments/save-during-payment
compatible Source: /payments/payment-methods/transitioning#compatibility
confirm API: /api/payment_intents/confirm
confirm this PaymentIntent: /api/payment_intents/confirm
confirm: /api/payment_intents/confirm
confirm=true: /api/payment_intents/create#create_payment_intent-confirm
email settings: https://dashboard.stripe.com/account/emails
equivalent in charge currency: /currencies#minimum-and-maximum-charge-amounts
generated_card: /api/charges/object#charge_object-payment_method_details-card_present-generated_card
key-value pairs: /api/metadata
smallest currency unit: /currencies#zero-decimal
statement descriptor prefix: /get-started/account/statement-descriptors#static
statement_descriptor_suffix: /get-started/account/statement-descriptors#dynamic
supported currency: /currencies
the Statement Descriptor docs: /get-started/account/statement-descriptors
the available payment flows with the Payment Intents API: /payments/payment-intents

[content]
Create a PaymentIntent | Stripe API Reference
Find anything
/
Ask AI
Introduction
Authentication
Errors
Expanding Responses
Idempotent requests
Include-dependent response values (API v2)
Metadata
Pagination
Request IDs
Connected Accounts
Versioning
Enums
Core Resources
Accounts
v2
Account Links
v2
Account Tokens
v2
Balances
Balance Transactions
Charges
Customers
Customer Sessions
Disputes
Events
Events
v2
Event Destinations
v2
Files
File Links
Mandates
Payment Intents
The PaymentIntent object
Create a PaymentIntent
Update a PaymentIntent
Retrieve a PaymentIntent
List all PaymentIntents
List all PaymentIntent LineItems
Cancel a PaymentIntent
Capture a PaymentIntent
Confirm a PaymentIntent
Increment an authorization
Reconcile a customer_balance PaymentIntent
Search PaymentIntents
Verify microdeposits on a PaymentIntent
Persons
v2
Person Tokens
v2
Setup Intents
Setup Attempts
Stripe Balance Debit Agreements
Payouts
Refunds
Confirmation Tokens
Tokens
Payment Methods
Payment Methods
Payment Method Configurations
Payment Method Domains
Bank Accounts
Cash Balances
Cash Balance Transactions
Cards
Sources
Products
Products
Prices
Coupons
Promotion Codes
Discounts
Tax Codes
Tax Rates
Shipping Rates
Commerce
Agentic Commerce
Shared Payment Issued Tokens
Shared Payment Granted Tokens
Checkout
Checkout Sessions
Payment Links
Payment Links
Billing
Alerts
Credit Balance Summaries
Credit Balance Transactions
Credit Grants
Credit Notes
Customer Balance Transactions
Customer Portal Configurations
Customer Portal Sessions
Invoices
Invoice Items
Invoice Line Items
Invoice Payments
Invoice Rendering Templates
Meters
Meter Events
Meter Event Adjustment
Meter Event Adjustments
v2
Meter Event Streams
v2
Meter Event Summary
Meter Events
v2
Plans
Quotes
Subscriptions
Subscription Items
Subscription Schedules
Tax IDs
Test Clocks
Capital
Financing Offers
Financing Summaries
Connect
Accounts
Login Links
Account Links
Account Sessions
Application Fees
Application Fee Refunds
Capabilities
Country Specs
Balance Settings
External Bank Accounts
External Account Cards
Persons
Top-ups
Transfers
Transfer Reversals
Secrets
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks
2026-07-29
.
dahlia
API Reference
Docs
Support
Sign in
→
Create a PaymentIntent
Ask about this section
Copy for LLM
View as Markdown
POST
/
v1
/
payment_intents
Creates a PaymentIntent object.
After the PaymentIntent is created, attach a payment method and
confirm
to continue the payment. Learn more about
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
when you supply
confirm=true
.
Parameters
amount
integer
Required
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).
currency
enum
Required
Three-letter
ISO currency code
, in lowercase. Must be a
supported currency
.
automatic
_
payment
_
methods
object
When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent’s other parameters.
Show child parameters
confirm
boolean
Set to
true
to attempt to
confirm this PaymentIntent
immediately. This parameter defaults to
false
. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the
Confirm API
.
customer
string
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.
metadata
map
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
off
_
session
boolean | string
only when confirm=true
Set to
true
to indicate that the customer isn’t in your checkout flow during this payment attempt and can’t authenticate. Use this parameter in scenarios where you collect payment method details and
charge them later
. This parameter can only be used with
confirm=true
.
payment
_
method
string
ID of the payment method (a PaymentMethod, Card, or
compatible Source
object) to attach to this PaymentIntent.
If you omit this parameter with
confirm=true
,
customer
.
default
_
source
attaches as this PaymentIntent’s payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the
payment
_
method
moving forward.
If the payment method is attached to a Customer, you must also provide the ID of that Customer as the
customer
parameter of this PaymentIntent.
receipt
_
email
string
Email address to send the receipt to. If you specify
receipt
_
email
for a payment in live mode, you send a receipt regardless of your
email settings
.
setup
_
future
_
usage
enum
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
.
Possible enum values
off
_
session
Use
off
_
session
if your customer may or may not be present in your checkout flow.
on
_
session
Use
on
_
session
if you intend to only reuse the payment method when your customer is present in your checkout flow.
shipping
object
Shipping information for this PaymentIntent.
Show child parameters
statement
_
descriptor
string
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
_
suffix
string
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.
More parameters
Expand all
allowed
_
payment
_
method
_
types
array of enums
amount
_
details
object
application
_
fee
_
amount
integer
Connect only
capture
_
method
enum
confirmation
_
method
enum
confirmation
_
token
string
only when confirm=true
error
_
on
_
requires
_
action
boolean
only when confirm=true
excluded
_
payment
_
method
_
types
array of enums
hooks
object
mandate
string
only when confirm=true
mandate
_
data
object
only when confirm=true
on
_
behalf
_
of
string
Connect only
payment
_
details
object
payment
_
method
_
configuration
string
payment
_
method
_
data
object
payment
_
method
_
options
object
payment
_
method
_
types
array of strings
radar
_
options
object
return
_
url
string
only when confirm=true
transfer
_
data
object
Connect only
transfer
_
group
string
Connect only
use
_
stripe
_
sdk
boolean
Returns
Returns a PaymentIntent object.
curl
https://api.stripe.com/v1/payment_intents \
-u
"
sk_test_wsFx86XDJWwmE4dMskBgJYrt
sk_test_wsFx86XDJWwmE4dMskBgJYrt
:
"
\
-d amount=2000 \
-d currency=usd \
-d
"
automatic_payment_methods[enabled]=true
"
Response
{
"
id
"
:
"
pi_3MtwBwLkdIwHu7ix28a3tqPa
"
,
"
object
"
:
"
payment_intent
"
,
"
amount
"
:
2000
,
"
amount_capturable
"
:
0
,
"
amount_details
"
:
{
"
tip
"
:
{}
},
"
amount_received
"
:
0
,
"
application
"
:
null
,
"
application_fee_amount
"
:
null
,
"
automatic_payment_methods
"
:
{
"
enabled
"
:
true
},
"
canceled_at
"
:
null
,
"
cancellation_reason
"
:
null
,
"
capture_method
"
:
"
automatic
"
,
"
client_secret
"
:
"
pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH
"
,
"
confirmation_method
"
:
"
automatic
"
,
"
created
"
:
1680800504
,
"
currency
"
:
"
usd
"
,
"
customer
"
:
null
,
"
description
"
:
null
,
"
last_payment_error
"
:
null
,
"
latest_charge
"
:
null
,
"
livemode
"
:
false
,
"
metadata
"
:
{},
"
next_action
"
:
null
,
"
on_behalf_of
"
:
null
,
"
payment_method
"
:
null
,
"
payment_method_options
"
:
{
"
card
"
:
{
"
installments
"
:
null
,
"
mandate_options
"
:
null
,
"
network
"
:
null
,
"
request_three_d_secure
"
:
"
automatic
"
},
"
link
"
:
{
"
persistent_token
"
:
null
}
},
"
payment_method_types
"
:
[
"
card
"
,
"
link
"
],
"
processing
"
:
null
,
"
receipt_email
"
:
null
,
"
review
"
:
null
,
"
setup_future_usage
"
:
null
,
"
shipping
"
:
null
,
"
source
"
:
null
,
"
statement_descriptor
"
:
null
,
"
statement_descriptor_suffix
"
:
null
,
"
status
"
:
"
requires_payment_method
"
,
"
transfer_data
"
:
null
,
"
transfer_group
"
:
null
}
Update a PaymentIntent
Ask about this section
Copy for LLM
View as Markdown
POST
/
v1
/
payment_intents
/
:id
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
instead.
Parameters
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).
currency
enum
Three-letter
ISO currency code
, in lowercase. Must be a
supported currency
.
customer
string
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.
metadata
map
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
payment
_
method
string
ID of the payment method (a PaymentMethod, Card, or
compatible Source
object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string.
receipt
_
email
string
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
enum
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
.
If you’ve already set
setup
_
future
_
usage
and you’re performing a request using a publishable key, you can only update the value from
on
_
session
to
off
_
session
.
Possible enum values
off
_
session
Use
off
_
session
if your customer may or may not be present in your checkout flow.
on
_
session
Use
on
_
session
if you intend to only reuse the payment method when your customer is present in your checkout flow.
shipping
object
Shipping information for this PaymentIntent.
Show child parameters
statement
_
descriptor
string
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
_
suffix
string
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.
More parameters
Expand all
allowed
_
payment
_
method
_
types
array of enums
amount
_
details
object
application
_
fee
_
amount
integer
Connect only
capture
_
method
enum
secret key only
excluded
_
payment
_
method
_
types
array of enums
hooks
object
payment
_
details
object
payment
_
method
_
configuration
string
payment
_
method
_
data
object
payment
_
method
_
options
object
payment
_
method
_
types
array of strings
transfer
_
data
object
Connect only
transfer
_
group
string
Connect only
Returns
Returns a PaymentIntent object.
curl
https://api.stripe.com/v1/payment_intents/
{{PAYMENT_INTENT_ID}}
\
-u
"
sk_test_wsFx86XDJWwmE4dMskBgJYrt
sk_test_wsFx86XDJWwmE4dMskBgJYrt
:
"
\
-d
"
metadata[order_id]=6735
"
Response
{
"
id
"
:
"
pi_3MtwBwLkdIwHu7ix28a3tqPa
"
,
"
object
"
:
"
payment_intent
"
,
"
amount
"
:
2000
,
"
amount_capturable
"
:
0
,
"
amount_details
"
:
{
"
tip
"
:
{}
},
"
amount_received
"
:
0
,
"
application
"
:
null
,
"
application_fee_amount
"
:
null
,
"
automatic_payment_methods
"
:
{
"
enabled
"
:
true
},
"
canceled_at
"
:
null
,
"
cancellation_reason
"
:
null
,
"
capture_method
"
:
"
automatic
"
,
"
client_secret
"
:
"
pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH
"
,
"
confirmation_method
"
:
"
automatic
"
,
"
created
"
:
1680800504
,
"
currency
"
:
"
usd
"
,
"
customer
"
:
null
,
"
description
"
:
null
,
"
last_payment_error
"
:
null
,
"
latest_charge
"
:
null
,
"
livemode
"
:
false
,
"
metadata
"
:
{
"
order_id
"
:
"
6735
"
},
"
next_action
"
:
null
,
"
on_behalf_of
"
:
null
,
"
payment_method
"
:
null
,
"
payment_method_options
"
:
{
"
card
"
:
{
"
installments
"
:
null
,
"
mandate_options
"
:
null
,
"
network
"
:
null
,
"
request_three_d_secure
"
:
"
automatic
"
},
"
link
"
:
{
"
persistent_token
"
:
null
}
},
"
payment_method_types
"
:
[
"
card
"
,
"
link
"
],
"
processing
"
:
null
,
"
receipt_email
"
:
null
,
"
review
"
:
null
,
"
setup_future_usage
"
:
null
,
"
shipping
"
:
null
,
"
source
"
:
null
,
"
statement_descriptor
"
:
null
,
"
statement_descriptor_suffix
"
:
null
,
"
status
"
:
"
requires_payment_method
"
,
"
transfer_data
"
:
null
,
"
transfer_group
"
:
null
}
Retrieve a PaymentIntent
Ask about this section
Copy for LLM
View as Markdown
GET
/
v1
/
payment_intents
/
:id
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.
Parameters
client
_
secret
string
Required if you use a publishable key.
The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.
Returns
Returns a PaymentIntent if a valid identifier was provided.
curl
https://api.stripe.com/v1/payment_intents/
{{PAYMENT_INTENT_ID}}
\
-u
"
sk_test_wsFx86XDJWwmE4dMskBgJYrt
sk_test_wsFx86XDJWwmE4dMskBgJYrt
:
"
Response
{
"
id
"
:
"
pi_3MtwBwLkdIwHu7ix28a3tqPa
"
,
"
object
"
:
"
payment_intent
"
,
"
amount
"
:
2000
,
"
amount_capturable
"
:
0
,
"
amount_details
"
:
{
"
tip
"
:
{}
},
"
amount_received
"
:
0
,
"
application
"
:
null
,
"
application_fee_amount
"
:
null
,
"
automatic_payment_methods
"
:
{
"
enabled
"
:
true
},
"
canceled_at
"
:
null
,
"
cancellation_reason
"
:
null
,
"
capture_method
"
:
"
automatic
"
,
"
client_secret
"
:
"
pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH
"
,
"
confirmation_method
"
:
"
automatic
"
,
"
created
"
:
1680800504
,
"
currency
"
:
"
usd
"
,
"
customer
"
:
null
,
"
description
"
:
null
,
"
last_payment_error
"
:
null
,
"
latest_charge
"
:
null
,
"
livemode
"
:
false
,
"
metadata
"
:
{},
"
next_action
"
:
null
,
"
on_behalf_of
"
:
null
,
"
payment_method
"
:
null
,
"
payment_method_options
"
:
{
"
card
"
:
{
"
installments
"
:
null
,
"
mandate_options
"
:
null
,
"
network
"
:
null
,
"
request_three_d_secure
"
:
"
automatic
"
},
"
link
"
:
{
"
persistent_token
"
:
null
}
},
"
payment_method_types
"
:
[
"
card
"
,
"
link
"
],
"
processing
"
:
null
,
"
receipt_email
"
:
null
,
"
review
"
:
null
,
"
setup_future_usage
"
:
null
,
"
shipping
"
:
null
,
"
source
"
:
null
,
"
statement_descriptor
"
:
null
,
"
statement_descriptor_suffix
"
:
null
,
"
status
"
:
"
requires_payment_method
"
,
"
transfer_data
"
:
null
,
"
transfer_group
"
:
null
}
Need help?
Contact Support
.
Chat with Stripe developers on
Discord
.
Check out our
changelog
.
Questions?
Contact Sales
.
LLM?
Read llms.txt
.
Powered by
Markdoc
