Transactions represent changes to a FinancialAccount’s balance.
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 valuescredit_
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 valuefalse
if the object exists in test mode. - statusenum
Status of the Transaction.
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 Hash containing timestamps of when the object transitioned to a particular
status
.
{ "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 }}
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.
{ "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 }}
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
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
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 } } ]}
TransactionEntries represent individual units of money movements within a single Transaction.