Returns a list of SetupIntents.
Parameters
- customerstring
Only return SetupIntents for the customer specified by this customer ID.
- payment_
methodstring Only return SetupIntents that associate with the specified payment method.
More parameters
- attach_
to_ selfboolean - createdobject
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
SetupIntents, starting after SetupIntent starting_
. Each entry in the array is a separate SetupIntent object. If no more SetupIntents are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/setup_intents", "has_more": false, "data": [ { "id": "seti_1Mm8s8LkdIwHu7ix0OXBfTRG", "object": "setup_intent", "application": null, "cancellation_reason": null, "client_secret": "seti_1Mm8s8LkdIwHu7ix0OXBfTRG_secret_NXDICkPqPeiBTAFqWmkbff09lRmSVXe", "created": 1678942624, "customer": null, "description": null, "flow_directions": null, "last_setup_error": null, "latest_attempt": null, "livemode": false, "mandate": null, "metadata": {}, "next_action": null, "on_behalf_of": null, "payment_method": null, "payment_method_options": { "card": { "mandate_options": null, "network": null, "request_three_d_secure": "automatic" } }, "payment_method_types": [ "card" ], "single_use_mandate": null, "status": "requires_payment_method", "usage": "off_session" } ]}
You can cancel a SetupIntent object when itâs in one of these statuses: requires_
, requires_
, or requires_
.
After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You canât cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.
Parameters
- cancellation_
reasonstring Reason for canceling this SetupIntent. Possible values are:
abandoned
,requested_
, orby_ customer duplicate
Returns
Returns a SetupIntent object if the cancellation succeeds. Returns an error if the SetupIntent is already canceled or isnât in a cancelable state.
{ "id": "seti_1Mm8s8LkdIwHu7ix0OXBfTRG", "object": "setup_intent", "application": null, "cancellation_reason": null, "client_secret": "seti_1Mm8s8LkdIwHu7ix0OXBfTRG_secret_NXDICkPqPeiBTAFqWmkbff09lRmSVXe", "created": 1678942624, "customer": null, "description": null, "flow_directions": null, "last_setup_error": null, "latest_attempt": null, "livemode": false, "mandate": null, "metadata": {}, "next_action": null, "on_behalf_of": null, "payment_method": null, "payment_method_options": { "card": { "mandate_options": null, "network": null, "request_three_d_secure": "automatic" } }, "payment_method_types": [ "card" ], "single_use_mandate": null, "status": "canceled", "usage": "off_session"}
Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the âSaveâ button on a payment method management page on your website.
If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded
status.
Otherwise, it will transition to the requires_
status and suggest additional actions via next_
. If setup fails, the SetupIntent will transition to the requires_
status or the canceled
status if the confirmation limit is reached.
Parameters
- payment_
methodstring ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
More parameters
- confirmation_
tokenstring - mandate_
dataobject - payment_
method_ dataobject - payment_
method_ optionsobjectsecret key only - return_
urlstring - use_
stripe_ sdkboolean
Returns
Returns the resulting SetupIntent after all possible transitions are applied.
{ "id": "seti_1Mm2cBLkdIwHu7ixaiKW3ElR", "object": "setup_intent", "application": null, "cancellation_reason": null, "client_secret": "seti_1Mm2cBLkdIwHu7ixaiKW3ElR_secret_NX6phB7HbSmlkpqzKZ3Bxr7uXFRf9Jg", "created": 1678918571, "customer": null, "description": null, "flow_directions": null, "last_setup_error": null, "latest_attempt": "setatt_1Mm2cBLkdIwHu7ixdEp1VkXJ", "livemode": false, "mandate": null, "metadata": {}, "next_action": null, "on_behalf_of": null, "payment_method": "pm_1Mm2cBLkdIwHu7ixGoOfZSsV", "payment_method_options": { "card": { "mandate_options": null, "network": null, "request_three_d_secure": "automatic" } }, "payment_method_types": [ "card" ], "single_use_mandate": null, "status": "succeeded", "usage": "off_session"}
Verifies microdeposits on a SetupIntent object.
Parameters
- amountsarray of integers
Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
- descriptor_
codestring A six-character code starting with SM present in the microdeposit sent to the bank account.
Returns
Returns a SetupIntent object.
{ "id": "seti_1Mm5yZLkdIwHu7ixm0sPzrx4", "object": "setup_intent", "application": null, "cancellation_reason": null, "client_secret": "seti_1Mm5yZLkdIwHu7ixm0sPzrx4_secret_NXAJ5iPM38ITW1pI7o8VZZhoZyDrrWR", "created": 1678931491, "customer": null, "description": null, "flow_directions": null, "last_setup_error": null, "latest_attempt": "setatt_1Mm5yZLkdIwHu7ix7QtOkLAu", "livemode": false, "mandate": "mandate_1Mm5yaLkdIwHu7ixmNoLkKLC", "metadata": {}, "next_action": null, "on_behalf_of": null, "payment_method": "pm_1Mm5yZLkdIwHu7ixf89jW57b", "payment_method_options": { "acss_debit": { "currency": "cad", "mandate_options": { "interval_description": "First of every month", "payment_schedule": "interval", "transaction_type": "personal" }, "verification_method": "automatic" } }, "payment_method_types": [ "acss_debit" ], "single_use_mandate": null, "status": "succeeded", "usage": "off_session"}
A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.
A Payout
object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry.
Related guide: Receiving payouts
Refund objects allow you to refund a previously created charge that isnât refunded yet. Funds are refunded to the credit or debit card thatâs initially charged.
Related guide: Refunds
ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent. If the confirmation is successful, values present on the ConfirmationToken are written onto the Intent.
To learn more about how to use ConfirmationToken, visit the related guides:
Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our recommended payments integrations to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way.
If you canât use client-side tokenization, you can also create tokens using the API with either your publishable or secret API key. If your integration uses this method, youâre responsible for any PCI compliance that it might require, and you must keep your secret API key safe. Unlike with client-side tokenization, your customerâs information isnât sent directly to Stripe, so we canât determine how itâs handled or stored.
You canât store or use tokens more than once. To store card or bank account information for later use, create Customer objects or External accounts. Radar, our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization.
PaymentMethod objects represent your customerâs payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.
Related guides: Payment Methods and More Payment Scenarios.
PaymentMethodConfigurations control which payment methods are displayed to your customers when you donât explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.
There are two types of PaymentMethodConfigurations. Which is used depends on the charge type:
Direct configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.
Child configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.
Child configurations have a parent
that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected accountâs associated child configuration. Parent configurations are managed in the dashboard and are not available in this API.
Related guides:
A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where certain payment methods are shown.
Related guide: Payment method domains.
These bank accounts are payment methods on Customer
objects.
On the other hand External Accounts are transfer destinations on Account
objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above.
Related guide: Bank debits and transfers
A customerâs Cash balance
represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.
You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.
Related guide: Card payments with Sources
Sources Deprecated
Source
objects allow you to accept a variety of payment methods. They represent a customerâs payment instrument, and can be used with the Stripe API just like a Card
object: once chargeable, they can be charged, or can be attached to customers.
Stripe doesnât recommend using the deprecated Sources API. We recommend that you adopt the PaymentMethods API. This newer API provides access to our latest features and payment method types.
Related guides: Sources API and Sources & Customers.
Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with Prices to configure pricing in Payment Links, Checkout, and Subscriptions.
Related guides: Set up a subscription, share a Payment Link, accept payments with Checkout, and more about Products and Prices
Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single âgoldâ product that has prices for $10/month, $100/year, and â¬9 once.
Related guides: Set up a subscription, create an invoice, and more about products and prices.
A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.
A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.
A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
Related guide: Applying discounts to subscriptions
Tax codes classify goods and services for tax purposes.
Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
Related guide: Tax rates
Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see Charge for shipping.
A Checkout Session represents your customerâs session as they pay for one-time purchases or subscriptions through Checkout or Payment Links. We recommend creating a new Session each time your customer attempts to pay.
Once payment is successful, the Checkout Session will contain a reference to the Customer, and either the successful PaymentIntent or an active Subscription.
You can create a Checkout Session on your server and redirect to its URL to begin Checkout.
Related guide: Checkout quickstart
A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.
When a customer opens a payment link it will open a new checkout session to render the payment page. You can use checkout session events to track payments through payment links.
Related guide: Payment Links API
Issue a credit note to adjust an invoiceâs amount after the invoice is finalized.
Related guide: Credit notes
Each customer has a Balance value, which denotes a debit or credit thatâs automatically applied to their next invoice upon finalization. You may modify the value directly by using the update customer API, or by creating a Customer Balance Transaction, which increments or decrements the customerâs balance
by the specified amount
.
Related guide: Customer balance
The Billing customer portal is a Stripe-hosted UI for subscription and billing management.
A portal configuration describes the functionality and features that you want to provide to your customers through the portal.
A portal session describes the instantiation of the customer portal for a particular customer. By visiting the sessionâs URL, the customer can manage their subscriptions and billing details. For security reasons, sessions are short-lived and will expire if the customer does not visit the URL. Create sessions on-demand when customers intend to manage their subscriptions and billing details.
Related guide: Customer management
A portal configuration describes the functionality and behavior of a portal session.
Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.
They contain invoice items, and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).
If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, when automatic, does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice.
If your invoice is configured to be billed by sending an email, then based on your email settings, Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice.
Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripeâs minimum allowed charge per currency, the invoice is automatically marked paid, and we add the amount due to the customerâs credit balance which is applied to the next invoice.
More details on the customerâs credit balance are here.
Related guide: Send invoices to customers
- POST/
Invoice Items represent the component lines of an invoice. An invoice item is added to an invoice by creating or updating it with an invoice
field, at which point it will be included as an invoice line item within invoice.lines.
Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a subscription. Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customerâs card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.
Related guides: Integrate with the Invoicing API, Subscription Invoices.
Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice.
Each line item is backed by either an invoice item or a subscription item.
Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates can be created from within the Dashboard, and they can be used over the API when creating invoices.
A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.
Related guide: Usage based billing
Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the eventâs payload and how to aggregate those events.
Meter events are used to report customer usage of your product or service. Meter events are associated with billing meters, which define the shape of the eventâs payload and how those events are aggregated. Meter events are processed asynchronously, so they may not be immediately reflected in aggregates or on upcoming invoices.
A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
You can send a higher-throughput of meter events using meter event streams. For this flow, you must first create a meter event session, which will provide you with a session token. You can then create meter events through the meter event stream endpoint, using the session token for authentication. The session tokens are short-lived and you will need to create a new meter event session when the token expires.
A billing meter event summary represents an aggregated view of a customerâs billing meter events within a specified timeframe. It indicates how much usage was accrued by a customer for that period.
A credit grant is an API resource that documents the allocation of some billing credits to a customer.
Related guide: Billing credits
Indicates the billing credit balance for billing credits granted to a customer.
A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single âgoldâ product that has plans for $10/month, $100/year, â¬9/month, and â¬90/year.
Related guides: Set up a subscription and more about products and prices.
A Quote is a way to model prices that youâd like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.
Subscriptions allow you to charge a customer on a recurring basis.
Related guide: Creating subscriptions
Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.
A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
Related guide: Subscription schedules
You can add one or multiple tax IDs to a customer or account. Customer and account tax IDs get displayed on related invoices and credit notes.
Related guides: Customer tax identification numbers, Account tax IDs
Test Clocks Test helper
A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.
Usage records allow you to report customer usage and metrics to Stripe for metered billing of subscription prices.
Related guide: Metered billing
This is our legacy usage-based billing API. See the updated usage-based billing docs.
A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period.
Financing Offer Preview feature
This is an object representing an offer of financing from Stripe Capital to a Connect subaccount.
Financing Summary Preview feature
A financing object describes an accountâs current financing state. Used by Connect platforms to read the state of Capital offered to their connected accounts.
This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
For accounts where controller.requirement_collection is application
, which includes Custom accounts, the properties below are always returned.
For accounts where controller.requirement_collection is stripe
, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.
Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected accountâs account.controller.stripe_dashboard.type must be express
to have access to the Express Dashboard.
Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding.
Related guide: Connect Onboarding
An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
We recommend that you create an AccountSession each time you need to display an embedded component to your user. Do not save AccountSessions to your database as they expire relatively quickly, and cannot be used more than once.
Related guide: Connect embedded components
When you collect a transaction fee on top of a charge made for your user (using Connect), an Application Fee
object is created in your account. You can list, retrieve, and refund application fees.
Related guide: Collecting application fees
Application Fee Refund
objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.
Related guide: Refunding application fees
This is an object representing a capability for a Stripe account.
Related guide: Account capabilities
Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the accountâs country. The Country Specs API makes these rules available to your integration.
You can also view the information from this API call as an online guide.
External bank accounts are financial accounts associated with a Stripe platformâs connected accounts for the purpose of transferring funds to or from the connected accountâs Stripe balance.
External account cards are debit cards associated with a Stripe platformâs connected accounts for the purpose of transferring funds to or from the connected accounts Stripe balance.
This is an object representing a person associated with a Stripe account.
A platform cannot access a person for an account where account.controller.requirement_collection is stripe
, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.
To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.
Related guide: Topping up your platform account
A Transfer
object is created when you move funds between Stripe accounts as part of Connect.
Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a Payout object, with corresponding payout endpoints. For more information, read about the transfer/payout split.
Related guide: Creating separate charges and transfers
Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platformâs balance and subtract from the destination accountâs balance.
Reversing a transfer that was made for a destination charge is allowed only up to the amount of the charge. It is possible to reverse a transfer_group transfer only if the destination account has enough balance to cover the reversal.
Related guide: Reverse transfers
Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
The primary resource in Secret Store is a secret
. Other apps canât view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
All Dashboard users and the app backend share account
scoped secrets. Use the account
scope for secrets that donât change per-user, like a third-party API key.
A user
scoped secret is accessible by the app backend and one specific Dashboard user. Use the user
scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
Related guide: Store data between page reloads
An early fraud warning indicates that the card issuer has notified us that a charge may be fraudulent.
Related guide: Early fraud warnings
Reviews can be used to supplement automated fraud detection with human expertise.
Value lists allow you to group values together which can then be referenced in rules.
Related guide: Default Stripe lists
Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
Related guide: Managing list items
An Issuing Cardholder
object represents an individual or business entity who is issued cards.
Related guide: How to create a cardholder
You can create physical or virtual cards that are issued to cardholders.
- POST/
As a card issuer, you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
Related guide: Issuing disputes
Funding Instructions contain reusable bank account and routing information. Push funds to these addresses via bank transfer to top up Issuing Balances.
A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
- POST/
A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
Tokens Preview feature
An issuing token object is created when an issued card is added to a digital wallet. As a card issuer, you can view and manage these tokens through Stripe.
Any use of an issued card that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing Transaction
object.
Related guide: Issued card transactions
A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
Related guide: Fleet management
A Location represents a grouping of readers.
Related guide: Fleet management
A Reader represents a physical device for accepting payment details.
Related guide: Connecting to a reader
- POST/
Terminal Hardware Order Preview feature
A TerminalHardwareOrder represents an order for Terminal hardware, containing information such as the price, shipping information and the items ordered.
- POST/
Terminal Hardware Product Preview feature
A TerminalHardwareProduct is a category of hardware devices that are generally similar, but may have variations depending on the country itâs shipped to.
TerminalHardwareSKUs represent variations within the same Product (for example, a country specific device). For example, WisePOS E is a TerminalHardwareProduct and a WisePOS E - US and WisePOS E - UK are TerminalHardwareSKUs.
Terminal Hardware SKUÂ Preview feature
A TerminalHardwareSKU represents a SKU for Terminal hardware. A SKU is a representation of a product available for purchase, containing information such as the name, price, and images.
Terminal Hardware Shipping Method Preview feature
A TerminalHardwareShipping represents a Shipping Method for Terminal hardware. A Shipping Method is a country-specific representation of a way to ship hardware, containing information such as the country, name, and expected delivery date.
A Configurations object represents how features should be configured for terminal readers.
Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance. FinancialAccounts serve as the source and destination of Treasuryâs money movement APIs.
Encodes whether a FinancialAccount has access to a particular Feature, with a status
enum and associated status_
. Stripe or the platform can control Features via the requested field.
Transactions represent changes to a FinancialAccountâs balance.
TransactionEntries represent individual units of money movements within a single Transaction.
Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds over ACH rails or through a domestic wire transfer to a userâs own external bank account.
Simulate OutboundTransfer state changes with the /v1/test_
endpoints. These methods can only be called on test mode objects.
Related guide: Moving money with Treasury using OutboundTransfer objects
- POST/
Use OutboundPayments to send funds to another partyâs external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer.
Simulate OutboundPayment state changes with the /v1/test_
endpoints. These methods can only be called on test mode objects.
Related guide: Moving money with Treasury using OutboundPayment objects
- POST/
Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
Related guide: Moving money with Treasury using InboundTransfer objects
- POST/
ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
ReceivedDebits represent funds pulled from a FinancialAccount. These are not initiated from the FinancialAccount.
You can reverse some ReceivedCredits depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
You can reverse some ReceivedDebits depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
A product_feature represents an attachment between a feature and a product. When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.
An active entitlement describes access to a feature for a customer.
If you have scheduled a Sigma query, youâll receive a sigma.
webhook each time the query runs. The webhook contains a ScheduledQueryRun
object, which you can use to retrieve the query results.
The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.
Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.
The Report Type resource corresponds to a particular type of report, such as the âActivity summaryâ or âItemized payoutsâ reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.
Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.
A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
Describes an owner of an account.
A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
A Transaction represents a real transaction that affects a Financial Connections Account balance.
A Tax Calculation allows you to calculate the tax to collect from your customer.
Related guide: Calculate tax in your custom payment flow
A Tax Registration
lets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax.
Stripe doesnât register on your behalf with the relevant authorities when you create a Tax Registration
object. For more information on how to register to collect tax, see our guide.
Related guide: Using the Registrations API
A Tax Transaction records the tax collected from or refunded to your customer.
Related guide: Calculate tax in your custom payment flow
You can use Tax Settings
to manage configurations used by Stripe Tax calculations.
Related guide: Using the Settings API
A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.
A VerificationSession transitions through multiple statuses throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the userâs verified data after verification checks are complete.
Related guide: The Verification Sessions API
A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type
and options
parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document
, id_
, selfie
.
Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.
Related guide: Accessing verification results.
A Crypto Onramp Session represents your customerâs session as they purchase cryptocurrency through Stripe. Once payment is successful, Stripe will fulfill the delivery of cryptocurrency to your userâs wallet and contain a reference to the crypto transaction ID.
You can create an onramp session on your server and embed the widget on your frontend. Alternatively, you can redirect your users to the standalone hosted onramp.
Related guide: Integrate the onramp
Crypto Onramp Quotes are estimated quotes for onramp conversions into all the different cryptocurrencies on different networks. The Quotes API allows you to display quotes in your product UI before directing the user to the onramp widget.
Related guide: Quotes API
Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.
A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.
A supplier of carbon removal.
Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request.
Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period.
You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request.
Forwarding Requests are synchronous requests that return a response or time out according to Stripeâs limits.
Related guide: Forward card details to third-party API endpoints.
You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.
Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.
Related guide: Setting up webhooks