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.
- created.
gtinteger Minimum value to filter by (exclusive)
- created.
gteinteger Minimum value to filter by (inclusive)
- created.
ltinteger Maximum value to filter by (exclusive)
- created.
lteinteger Maximum value to filter by (inclusive)
- order_
byenum The results are in reverse chronological order by
created
orposted_
. The default isat created
.Possible enum valuescreated
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
, orvoid
.Possible enum valuesopen
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_
timestamp. When using this filter,transitions. posted_ at status=posted
andorder_
must also be specified.by=posted_ at - status_transitions.
posted_ atobject Returns Transactions with
posted_
within the specified range.at - status_transitions.
posted_at. gtinteger Minimum value to filter by (exclusive)
- status_transitions.
posted_at. gteinteger Minimum value to filter by (inclusive)
- status_transitions.
posted_at. ltinteger Maximum value to filter by (exclusive)
- status_transitions.
posted_at. lteinteger Maximum value to filter by (inclusive)
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
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 } } ]}