Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Transactions 

Transactions represent changes to a FinancialAccount’s balance.

Endpoints

The Transaction object 

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

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

  • amountinteger

    Amount (in cents) transferred.

  • balance_impactobject

    The change made to each of the FinancialAccount’s sub-balances by the Transaction.

  • createdtimestamp

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

  • currencyenum

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

  • descriptionstring

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

  • entriesnullable objectExpandable

    A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.

  • financial_accountstring

    The FinancialAccount associated with this object.

  • flownullable string

    ID of the flow that created the Transaction.

  • flow_detailsnullable objectExpandable

    Details of the flow that created the Transaction.

  • flow_typeenum

    Type of the flow that created the Transaction.

    Possible enum values
    credit_reversal

    The Transaction is associated with a CreditReversal.

    debit_reversal

    The Transaction is associated with a DebitReversal.

    inbound_transfer

    The Transaction is associated with an InboundTransfer.

    issuing_authorization

    The Transaction is associated with an Issuing authorization.

    other

    The Transaction is associated with some other money movement not listed above.

    outbound_payment

    The Transaction is associated with an OutboundPayment.

    outbound_transfer

    The Transaction is associated with an OutboundTransfer.

    received_credit

    The Transaction is associated with a ReceivedCredit.

    received_debit

    The Transaction is associated with a ReceivedDebit.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • statusenum

    Status of the Transaction.

    Possible enum values
    open

    The initial state for all Transactions. The Transaction results in updates to the sub-balance amounts, but the current balance is not affected until the Transaction posts.

    posted

    Funds have successfully entered or left the account. The current balance was affected.

    void

    The Transaction never impacted the balance. For example, a Transaction would enter this state if an OutboundPayment was initiated but then canceled before the funds left the account.

  • status_transitionsobject

    Hash containing timestamps of when the object transitioned to a particular status.

The Transaction object
{
  "id": "trxn_1MtkYw2eZvKYlo2ClMGIO54z",
  "object": "treasury.transaction",
  "amount": -100,
  "balance_impact": {
    "cash": -100,
    "inbound_pending": 0,
    "outbound_pending": 100
  },
  "created": 1680755802,
  "currency": "usd",
  "description": "Jane Austen (6789) | Outbound transfer | transfer",
  "financial_account": "fa_1MtkYw2eZvKYlo2CrqmzUo3O",
  "flow": "obt_1MtkYw2eZvKYlo2CqsyBpQts",
  "flow_type": "outbound_transfer",
  "livemode": false,
  "status": "open",
  "status_transitions": {
    "posted_at": null,
    "void_at": null
  }
}

Retrieve a Transaction 

Retrieves the details of an existing Transaction.

Parameters

No parameters.

Returns

Returns a Transaction object if a valid identifier was provided. Otherwise, returns an error.

GET /v1/treasury/transactions/:id
curl https://api.stripe.com/v1/treasury/transactions/trxn_1MtkYw2eZvKYlo2ClMGIO54z \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "trxn_1MtkYw2eZvKYlo2ClMGIO54z",
  "object": "treasury.transaction",
  "amount": -100,
  "balance_impact": {
    "cash": -100,
    "inbound_pending": 0,
    "outbound_pending": 100
  },
  "created": 1680755802,
  "currency": "usd",
  "description": "Jane Austen (6789) | Outbound transfer | transfer",
  "financial_account": "fa_1MtkYw2eZvKYlo2CrqmzUo3O",
  "flow": "obt_1MtkYw2eZvKYlo2CqsyBpQts",
  "flow_type": "outbound_transfer",
  "livemode": false,
  "status": "open",
  "status_transitions": {
    "posted_at": null,
    "void_at": null
  }
}

List all Transactions 

Retrieves a list of Transaction objects.

Parameters

  • financial_accountstring

    Returns objects associated with this FinancialAccount.

  • createdobject

    Only return Transactions that were created during the given date interval.

  • order_byenum

    The results are in reverse chronological order by created or posted_at. The default is created.

    Possible enum values
    created

    Timestamp describing when the Transaction was created.

    posted_at

    Timestamp describing when the Transaction was posted.

  • statusenum

    Only return Transactions that have the given status: open, posted, or void.

    Possible enum values
    open

    The initial state for all Transactions. The Transaction results in updates to the sub-balance amounts, but the current balance is not affected until the Transaction posts.

    posted

    Funds have successfully entered or left the account. The current balance was affected.

    void

    The Transaction never impacted the balance. For example, a Transaction would enter this state if an OutboundPayment was initiated but then canceled before the funds left the account.

  • status_transitionsobject

    A filter for the status_transitions.posted_at timestamp. When using this filter, status=posted and order_by=posted_at must also be specified.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

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

GET /v1/treasury/transactions
curl -G https://api.stripe.com/v1/treasury/transactions \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d financial_account=fa_1MtkYw2eZvKYlo2CrqmzUo3O \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/treasury/transactions",
  "has_more": false,
  "data": [
    {
      "id": "trxn_1MtkYw2eZvKYlo2ClMGIO54z",
      "object": "treasury.transaction",
      "amount": -100,
      "balance_impact": {
        "cash": -100,
        "inbound_pending": 0,
        "outbound_pending": 100
      },
      "created": 1680755802,
      "currency": "usd",
      "description": "Jane Austen (6789) | Outbound transfer | transfer",
      "financial_account": "fa_1MtkYw2eZvKYlo2CrqmzUo3O",
      "flow": "obt_1MtkYw2eZvKYlo2CqsyBpQts",
      "flow_type": "outbound_transfer",
      "livemode": false,
      "status": "open",
      "status_transitions": {
        "posted_at": null,
        "void_at": null
      }
    }
  ]
}

Transaction Entries 

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

Endpoints

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.

Related guide: Moving money with Treasury using OutboundTransfer objects

Endpoints

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.

Related guide: Moving money with Treasury using OutboundPayment objects

Endpoints

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.

Related guide: Moving money with Treasury using InboundTransfer objects

Endpoints

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

Received Debits 

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

Endpoints

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

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

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

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

Active Entitlement 

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

Endpoints

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

Query Run 

Represents an ad-hoc execution of a Sigma query via the API

Endpoints

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

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

Accounts 

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

Endpoints

Account Owner 

Describes an owner of an account.

Endpoints

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

Transactions 

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

Endpoints

Tax Calculations 

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

Related guide: Calculate tax in your custom payment flow

Endpoints

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

Tax Transactions 

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

Related guide: Calculate tax in your custom payment flow

Endpoints

Tax Settings 

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

Related guide: Using the Settings API

Endpoints

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

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

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

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

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

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

Climate Supplier 

A supplier of carbon removal.

Endpoints

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.

Related guide: Forward card details to third-party API endpoints.

Endpoints

Redaction Job Preview

The Redaction Job object redacts Stripe objects. You can use it to coordinate the removal of personal information from selected objects, making them permanently inaccessible in the Stripe Dashboard and API.

Endpoints

Redaction Job Validation Error Preview

The Redaction Job validation error object contains information about errors that affect the ability to redact a specific object in a redaction job.

Endpoints

Webhook 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

Endpoints