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
createdorposted_. The default isat created.Possible enum valuescreatedTimestamp 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, orvoid.Possible enum valuesopenThe 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.
postedFunds have successfully entered or left the account. The current balance was affected.
voidThe 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_timestamp. When using this filter,transitions. posted_ at status=postedandorder_must also be specified.by=posted_ at
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_. Each entry in the array is a separate Transaction object. If no more Transactions are available, the resulting array will be empty.
{ "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 } } ]}