Update a Location

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Parameters

addressobject
The full address of the location. You can’t change the location’s country. If you need to modify the country field, create a new Location object and re-register any existing readers to that location.

display_namestring
A name for the location.

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

configuration_overridesstring

Returns

Returns an updated Location object if a valid identifier was provided.

POST /v1/terminal/locations/:id

Server-side language

curl https://api.stripe.com/v1/terminal/locations/tml_FBakXQG8bQk4Mm \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d display_name="Update Store Name"

Response

{
  "id": "tml_FBakXQG8bQk4Mm",
  "object": "terminal.location",
  "address": {
    "city": "San Francisco",
    "country": "US",
    "line1": "1234 Main Street",
    "line2": "",
    "postal_code": "94111",
    "state": "CA"
  },
  "display_name": "Update Store Name",
  "livemode": false,
  "metadata": {}
}

Retrieve a Location

Retrieves a Location object.

Parameters

No parameters.

Returns

Returns a Location object if a valid identifier was provided.

GET /v1/terminal/locations/:id

Server-side language

curl https://api.stripe.com/v1/terminal/locations/tml_FBakXQG8bQk4Mm \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

{
  "id": "tml_FBakXQG8bQk4Mm",
  "object": "terminal.location",
  "address": {
    "city": "San Francisco",
    "country": "US",
    "line1": "1234 Main Street",
    "line2": "",
    "postal_code": "94111",
    "state": "CA"
  },
  "display_name": "My First Store",
  "livemode": false,
  "metadata": {}
}

List all Locations

Returns a list of Location objects.

Parameters

No parameters.

More parameters

ending_beforestring

limitinteger

starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit locations, starting after location starting_after. Each entry in the array is a separate Terminal location object. If no more locations are available, the resulting array will be empty.

GET /v1/terminal/locations

Server-side language

curl -G https://api.stripe.com/v1/terminal/locations \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/terminal/locations",
  "has_more": false,
  "data": [
    {
      "id": "tml_FBakXQG8bQk4Mm",
      "object": "terminal.location",
      "address": {
        "city": "San Francisco",
        "country": "US",
        "line1": "1234 Main Street",
        "line2": "",
        "postal_code": "94111",
        "state": "CA"
      },
      "display_name": "My First Store",
      "livemode": false,
      "metadata": {}
    }
  ]
}

Delete a Location

Deletes a Location object.

Parameters

No parameters.

Returns

Returns the Location object that was deleted.

DELETE /v1/terminal/locations/:id

Server-side language

curl -X DELETE https://api.stripe.com/v1/terminal/locations/tml_FBakXQG8bQk4Mm \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"

Response

{
  "id": "tml_FBakXQG8bQk4Mm",
  "object": "terminal.location",
  "deleted": true
}

Reader

A Reader represents a physical device for accepting payment details.

Related guide: Connecting to a reader

Endpoints

POST/v1/terminal/readers

POST/v1/terminal/readers/:id

GET/v1/terminal/readers/:id

GET/v1/terminal/readers

DELETE/v1/terminal/readers/:id

POST/v1/terminal/readers/:id/cancel_action

POST/v1/terminal/readers/:id/collect_inputs

POST/v1/terminal/readers/:id/confirm_payment_intent

POST/v1/terminal/readers/:id/collect_payment_method

POST/v1/terminal/readers/:id/process_payment_intent

POST/v1/terminal/readers/:id/process_setup_intent

POST/v1/terminal/readers/:id/refund_payment

POST/v1/terminal/readers/:id/set_reader_display

POST/v1/test_helpers/terminal/readers/:id/present_payment_method

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.

Endpoints

POST/v1/terminal/hardware_orders

GET/v1/terminal/hardware_orders/:id

GET/v1/terminal/hardware_orders

POST/v1/terminal/hardware_orders/:id/cancel

GET/v1/terminal/hardware_orders/preview

POST/v1/test_helpers/terminal/hardware_orders/:id/mark_ready_to_ship

POST/v1/test_helpers/terminal/hardware_orders/:id/deliver

POST/v1/test_helpers/terminal/hardware_orders/:id/ship

POST/v1/test_helpers/terminal/hardware_orders/:id/mark_undeliverable

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.

Endpoints

GET/v1/terminal/hardware_products/:id

GET/v1/terminal/hardware_products

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.

Endpoints

GET/v1/terminal/hardware_skus/:id

GET/v1/terminal/hardware_skus

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.

Endpoints

GET/v1/terminal/hardware_shipping_methods/:id

GET/v1/terminal/hardware_shipping_methods

Configuration

A Configurations object represents how features should be configured for terminal readers.

Endpoints

POST/v1/terminal/configurations

POST/v1/terminal/configurations/:id

GET/v1/terminal/configurations/:id

GET/v1/terminal/configurations

DELETE/v1/terminal/configurations/:id

Financial Accounts

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.

Endpoints

POST/v1/treasury/financial_accounts

POST/v1/treasury/financial_accounts/:id

GET/v1/treasury/financial_accounts/:id

GET/v1/treasury/financial_accounts

Financial Account Features

Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details. Stripe or the platform can control Features via the requested field.

Endpoints

POST/v1/treasury/financial_accounts/:id/features

GET/v1/treasury/financial_accounts/:id/features

Transactions

Transactions represent changes to a FinancialAccount’s balance.

Endpoints

GET/v1/treasury/transactions/:id

GET/v1/treasury/transactions

Transaction Entries

TransactionEntries represent individual units of money movements within a single Transaction.

Endpoints

GET/v1/treasury/transaction_entries/:id

GET/v1/treasury/transaction_entries

Outbound Transfers

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_helpers/treasury/outbound_transfers endpoints. These methods can only be called on test mode objects.

Endpoints

POST/v1/treasury/outbound_transfers

GET/v1/treasury/outbound_transfers/:id

GET/v1/treasury/outbound_transfers

POST/v1/treasury/outbound_transfers/:id/cancel

POST/v1/test_helpers/treasury/outbound_transfers/:id/fail

POST/v1/test_helpers/treasury/outbound_transfers/:id/post

POST/v1/test_helpers/treasury/outbound_transfers/:id/return

POST/v1/test_helpers/treasury/outbound_transfers/:id

Outbound Payments

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_helpers/treasury/outbound_payments endpoints. These methods can only be called on test mode objects.

Endpoints

POST/v1/treasury/outbound_payments

GET/v1/treasury/outbound_payments/:id

GET/v1/treasury/outbound_payments

POST/v1/treasury/outbound_payments/:id/cancel

POST/v1/test_helpers/treasury/outbound_payments/:id/fail

POST/v1/test_helpers/treasury/outbound_payments/:id/post

POST/v1/test_helpers/treasury/outbound_payments/:id/return

POST/v1/test_helpers/treasury/outbound_payments/:id

Inbound Transfers

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.

Endpoints

POST/v1/treasury/inbound_transfers

GET/v1/treasury/inbound_transfers/:id

GET/v1/treasury/inbound_transfers

POST/v1/treasury/inbound_transfers/:id/cancel

POST/v1/test_helpers/treasury/inbound_transfers/:id/fail

POST/v1/test_helpers/treasury/inbound_transfers/:id/return

POST/v1/test_helpers/treasury/inbound_transfers/:id/succeed

Received Credits

ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.

Endpoints

GET/v1/treasury/received_credits/:id

GET/v1/treasury/received_credits

POST/v1/test_helpers/treasury/received_credits

Received Debits

ReceivedDebits represent funds pulled from a FinancialAccount. These are not initiated from the FinancialAccount.

Endpoints

GET/v1/treasury/received_debits/:id

GET/v1/treasury/received_debits

POST/v1/test_helpers/treasury/received_debits

Credit Reversals

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.

Endpoints

POST/v1/treasury/credit_reversals

GET/v1/treasury/credit_reversals/:id

GET/v1/treasury/credit_reversals

Debit Reversals

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.

Endpoints

POST/v1/treasury/debit_reversals

GET/v1/treasury/debit_reversals/:id

GET/v1/treasury/debit_reversals

Feature

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.

Endpoints

POST/v1/entitlements/features

GET/v1/entitlements/features

POST/v1/entitlements/features/:id

Product Feature

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.

Endpoints

GET/v1/products/:id/features

POST/v1/products/:id/features

DELETE/v1/products/:id/features/:id

Active Entitlement

An active entitlement describes access to a feature for a customer.

Endpoints

GET/v1/entitlements/active_entitlements/:id

GET/v1/entitlements/active_entitlements

Scheduled Queries

If you have scheduled a Sigma query, you’ll receive a sigma.scheduled_query_run.created webhook each time the query runs. The webhook contains a ScheduledQueryRun object, which you can use to retrieve the query results.

Endpoints

GET/v1/sigma/scheduled_query_runs/:id

GET/v1/sigma/scheduled_query_runs

Report Runs

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.

Endpoints

POST/v1/reporting/report_runs

GET/v1/reporting/report_runs/:id

GET/v1/reporting/report_runs

Report Types

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.

Endpoints

GET/v1/reporting/report_types/:id

GET/v1/reporting/report_types

Accounts

A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.

Endpoints

GET/v1/financial_connections/accounts/:id

GET/v1/financial_connections/accounts

POST/v1/financial_connections/accounts/:id/disconnect

POST/v1/financial_connections/accounts/:id/refresh

POST/v1/financial_connections/accounts/:id/subscribe

POST/v1/financial_connections/accounts/:id/unsubscribe

Account Owner

Describes an owner of an account.

Endpoints

GET/v1/financial_connections/accounts/:id/owners

Session

A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

Endpoints

POST/v1/financial_connections/sessions

GET/v1/financial_connections/sessions/:id

Transactions

A Transaction represents a real transaction that affects a Financial Connections Account balance.

Endpoints

GET/v1/financial_connections/transactions/:id

GET/v1/financial_connections/transactions

Tax Calculations

A Tax Calculation allows you to calculate the tax to collect from your customer.

Endpoints

POST/v1/tax/calculations

GET/v1/tax/calculations/:id/line_items

GET/v1/tax/calculations/:id

Tax Registrations

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

Endpoints

POST/v1/tax/registrations

POST/v1/tax/registrations/:id

GET/v1/tax/registrations/:id

GET/v1/tax/registrations

Tax Transactions

A Tax Transaction records the tax collected from or refunded to your customer.

Endpoints

POST/v1/tax/transactions/create_reversal

POST/v1/tax/transactions/create_from_calculation

GET/v1/tax/transactions/:id/line_items

GET/v1/tax/transactions/:id

Tax Settings

You can use Tax Settings to manage configurations used by Stripe Tax calculations.

Related guide: Using the Settings API

Endpoints

POST/v1/tax/settings

GET/v1/tax/settings

Verification Session

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

Endpoints

POST/v1/identity/verification_sessions

POST/v1/identity/verification_sessions/:id

GET/v1/identity/verification_sessions/:id

GET/v1/identity/verification_sessions

POST/v1/identity/verification_sessions/:id/cancel

POST/v1/identity/verification_sessions/:id/redact

Verification Report

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

Endpoints

GET/v1/identity/verification_reports/:id

GET/v1/identity/verification_reports

Crypto Onramp Session

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

Endpoints

POST/v1/crypto/onramp_sessions

GET/v1/crypto/onramp_sessions/:id

GET/v1/crypto/onramp_sessions

Crypto Onramp Quotes

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

Endpoints

GET/v1/crypto/onramp/quotes

Climate Order

Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.

Endpoints

POST/v1/climate/orders

POST/v1/climate/orders/:id

GET/v1/climate/orders/:id

GET/v1/climate/orders

POST/v1/climate/orders/:id/cancel

Climate Product

A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.

Endpoints

GET/v1/climate/products/:id

GET/v1/climate/products

Climate Supplier

A supplier of carbon removal.

Endpoints

GET/v1/climate/suppliers/:id

GET/v1/climate/suppliers

Forwarding Request

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.

Endpoints

POST/v1/forwarding/requests

GET/v1/forwarding/requests/:id

GET/v1/forwarding/requests