The Transaction object

Attributes

id string Unique identifier for the object.
object string, value is "treasury.transaction" String representing the object’s type. Objects of the same type share the same value.
amount integer Amount (in cents) transferred.
balance _ impact object The change made to each of the FinancialAccount’s sub-balances by the Transaction.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
description string An arbitrary string attached to the object. Often useful for displaying to users.
entries nullable object Includable A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.
financial _ account string The FinancialAccount associated with this object.
flow nullable string ID of the flow that created the Transaction.
flow _ details nullable object Includable Details of the flow that created the Transaction.
flow _ type enum Type of the flow that created the Transaction. 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.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
status enum Status of the Transaction. 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 _ transitions object 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 }}

Retrieve a Transaction

GET / v1 / treasury / transactions /:id

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.

Response

{ "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 }}

List all Transactions

GET / v1 / treasury / transactions

Retrieves a list of Transaction objects.

Parameters

financial _ account string Returns objects associated with this FinancialAccount.
created object Only return Transactions that were created during the given date interval.
order _ by enum 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.
status enum 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 _ transitions object 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 _ before string
limit integer
starting _ after string

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.

Response