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

Server-side language

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

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