The TransactionEntry object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

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

  • balance_impactobject

    The current impact of the TransactionEntry on the FinancialAccount’s balance.

  • 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.

  • effective_attimestamp

    When the TransactionEntry will impact the FinancialAccount’s balance.

  • financial_accountstring

    The FinancialAccount associated with this object.

  • flownullable string

    Token of the flow associated with the TransactionEntry.

  • flow_detailsnullable objectExpandable

    Details of the flow associated with the TransactionEntry.

  • flow_typeenum

    Type of the flow associated with the TransactionEntry.

    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.

  • transactionstringExpandable

    The Transaction associated with this object.

  • typeenum

    The specific money movement that generated the TransactionEntry.

    Possible enum values
    credit_reversal

    The TransactionEntry was generated by a CreditReversal.

    credit_reversal_posting

    The TransactionEntry was generated by a posted CreditReversal.

    debit_reversal

    The TransactionEntry was generated by a DebitReversal.

    inbound_transfer

    The TransactionEntry was generated by an InboundTransfer.

    inbound_transfer_return

    The TransactionEntry was generated by an InboundTransferReturn.

    issuing_authorization_hold

    The TransactionEntry was generated by an Issuing authorization hold.

    issuing_authorization_release

    The TransactionEntry was generated by an Issuing authorization release.

    other

    The TransactionEntry was generated by some other money movement.

    outbound_payment

    The TransactionEntry was generated by an OutboundPayment.

    outbound_payment_cancellation

    The TransactionEntry was generated by a cancelled OutboundPayment.

    Show 10 more
The TransactionEntry object
{
"id": "trxne_1MtkgV2eZvKYlo2CmofEnIwJ",
"object": "treasury.transaction_entry",
"balance_impact": {
"cash": 0,
"inbound_pending": 0,
"outbound_pending": -1000
},
"created": 1680756271,
"currency": "usd",
"effective_at": 1680756271,
"financial_account": "fa_1MtkgV2eZvKYlo2CdxyvnHeQ",
"flow": "obt_1MtkgV2eZvKYlo2CCxhXVFLB",
"flow_type": "outbound_transfer",
"livemode": false,
"transaction": "trxn_1MtkgV2eZvKYlo2CRYxD7KLh",
"type": "outbound_transfer"
}

Retrieve a TransactionEntry

Retrieves a TransactionEntry object.

Parameters

No parameters.

Returns

Returns a TransactionEntry object.

GET /v1/treasury/transaction_entries/:id
curl https://api.stripe.com/v1/treasury/transaction_entries/trxne_1MtkgV2eZvKYlo2CmofEnIwJ \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "trxne_1MtkgV2eZvKYlo2CmofEnIwJ",
"object": "treasury.transaction_entry",
"balance_impact": {
"cash": 0,
"inbound_pending": 0,
"outbound_pending": -1000
},
"created": 1680756271,
"currency": "usd",
"effective_at": 1680756271,
"financial_account": "fa_1MtkgV2eZvKYlo2CdxyvnHeQ",
"flow": "obt_1MtkgV2eZvKYlo2CCxhXVFLB",
"flow_type": "outbound_transfer",
"livemode": false,
"transaction": "trxn_1MtkgV2eZvKYlo2CRYxD7KLh",
"type": "outbound_transfer"
}

List all TransactionEntries

Retrieves a list of TransactionEntry objects.

Parameters

  • financial_accountstringRequired

    Returns objects associated with this FinancialAccount.

  • createdobject

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

  • order_byenum

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

    Possible enum values
    created

    Timestamp describing when the TransactionEntry was created.

    effective_at

    Timestamp describing when the TransactionEntry was effective.

  • transactionstring

    Only return TransactionEntries associated with this Transaction.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

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

GET /v1/treasury/transaction_entries
curl -G https://api.stripe.com/v1/treasury/transaction_entries \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d financial_account=fa_1MtkgV2eZvKYlo2CdxyvnHeQ \
-d limit=3
Response
{
"object": "list",
"url": "/v1/treasury/transaction_entries",
"has_more": false,
"data": [
{
"id": "trxne_1MtkgV2eZvKYlo2CmofEnIwJ",
"object": "treasury.transaction_entry",
"balance_impact": {
"cash": 0,
"inbound_pending": 0,
"outbound_pending": -1000
},
"created": 1680756271,
"currency": "usd",
"effective_at": 1680756271,
"financial_account": "fa_1MtkgV2eZvKYlo2CdxyvnHeQ",
"flow": "obt_1MtkgV2eZvKYlo2CCxhXVFLB",
"flow_type": "outbound_transfer",
"livemode": false,
"transaction": "trxn_1MtkgV2eZvKYlo2CRYxD7KLh",
"type": "outbound_transfer"
}
{...}
{...}
],
}

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.

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.

Received Credits

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

Received Debits

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

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.

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.

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.

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.

Active Entitlement

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

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.

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.

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.

Account Owner

Describes an owner of an account.

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.

Transactions

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

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

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

Tax Settings

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

Related guide: Using the Settings API

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

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 guides: Accessing verification results.

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

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

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.

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.

Forwarding RequestPreview feature

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.

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

Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$