Attributes
- idstring
Unique identifier for the object.
- objectstring, value is "v2.money_management.transaction"
String representing the object’s type. Objects of the same type share the same value of the object field.
- amountobject
The amount of the Transaction.
- balance_
impactobject The delta to the FinancialAccount’s balance. The balance_impact for the Transaction is equal to sum of its TransactionEntries that have
effective_s in the past.at - categoryenum
A descriptive category used to classify the Transaction.
Possible enum valuesadjustmentThis Transaction is the main Transaction for an Adjustment.
inbound_transfer This Transaction is the main Transaction for an InboundTransfer.
outbound_payment This Transaction is the main Transaction for an OutboundPayment.
outbound_transfer This Transaction is the main Transaction for an OutboundTransfer.
received_credit This Transaction is the main Transaction for a ReceivedCredit.
received_debit This Transaction is the main Transaction for a ReceivedDebit.
returnThis Transaction is for the return of funds, such as when an OutboundPayment is returned by the recipient’s bank.
stripe_fee This Transaction is for a fee assessed by Stripe.
- createdtimestamp
Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- financial_
accountstring Indicates the FinancialAccount affected by this Transaction.
- flowobject
Details about the Flow object that created the Transaction.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - statusenum
Current status of the Transaction. A Transaction is
pendingif eitherbalance_orimpact. inbound_ pending balance_is non-zero. A Transaction isimpact. outbound_ pending postedif onlybalance_is non-zero. A Transaction isimpact. available voidif there is no balance impact.postedandvoidare terminal states, and no additional entries will be added to the Transaction.Possible enum valuespendingThis Transaction’s balance impact is still pending (non-zero impact to either
inbound_orpending outbound_). Further entries may still be added that move funds between availability states.pending postedThis Transaction’s balance impact is fully posted (only
cashwill be non-zero). This status is final and no further entries will be added.voidThis Transaction’s balance impact has been voided (all values are zero). This status is final and no further entries will be added.
- status_
transitionsobject Timestamps for when the Transaction transitioned to a particular status.
{ "id": "trxn_65NygiBHKcUPGUI8A5Q16NoTesLDSQ1IgNPigisRKq0GAq", "object": "v2.money_management.transaction", "amount": { "value": -1000, "currency": "usd" }, "balance_impact": { "available": { "value": -1000, "currency": "usd" }, "inbound_pending": { "value": 0, "currency": "usd" }, "outbound_pending": { "value": 0, "currency": "usd" } }, "category": "outbound_transfer", "created": "2023-03-24T22:06:37.343Z", "financial_account": "fa_65NvnnT0stRlwPDg2kc16NoTesLDSQ1IgNPigisRKq00Km", "flow": { "outbound_transfer": "obt_65NygiAXfaPmQ5ev3oz16NoTesLDSQ1IgNPigisRKq07Fg", "type": "outbound_transfer" }, "status": "posted", "status_transitions": { "posted_at": "2023-03-24T22:06:35.409Z", "void_at": null }}Retrieves the details of a Transaction by ID.
Learn more about calling API v2 endpoints.Parameters
- idstringRequired
The ID of the Transaction to retrieve.
Returns
Response attributes
- idstring
Unique identifier for the object.
- objectstring, value is "v2.money_management.transaction"
String representing the object’s type. Objects of the same type share the same value of the object field.
- amountobject
The amount of the Transaction.
- balance_
impactobject The delta to the FinancialAccount’s balance. The balance_impact for the Transaction is equal to sum of its TransactionEntries that have
effective_s in the past.at - categoryenum
A descriptive category used to classify the Transaction.
Possible enum valuesadjustmentThis Transaction is the main Transaction for an Adjustment.
inbound_transfer This Transaction is the main Transaction for an InboundTransfer.
outbound_payment This Transaction is the main Transaction for an OutboundPayment.
outbound_transfer This Transaction is the main Transaction for an OutboundTransfer.
received_credit This Transaction is the main Transaction for a ReceivedCredit.
received_debit This Transaction is the main Transaction for a ReceivedDebit.
returnThis Transaction is for the return of funds, such as when an OutboundPayment is returned by the recipient’s bank.
stripe_fee This Transaction is for a fee assessed by Stripe.
- createdtimestamp
Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- financial_
accountstring Indicates the FinancialAccount affected by this Transaction.
- flowobject
Details about the Flow object that created the Transaction.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - statusenum
Current status of the Transaction. A Transaction is
pendingif eitherbalance_orimpact. inbound_ pending balance_is non-zero. A Transaction isimpact. outbound_ pending postedif onlybalance_is non-zero. A Transaction isimpact. available voidif there is no balance impact.postedandvoidare terminal states, and no additional entries will be added to the Transaction.Possible enum valuespendingThis Transaction’s balance impact is still pending (non-zero impact to either
inbound_orpending outbound_). Further entries may still be added that move funds between availability states.pending postedThis Transaction’s balance impact is fully posted (only
cashwill be non-zero). This status is final and no further entries will be added.voidThis Transaction’s balance impact has been voided (all values are zero). This status is final and no further entries will be added.
- status_
transitionsobject Timestamps for when the Transaction transitioned to a particular status.
The resource wasn’t found.
{ "id": "trxn_65NygiBHKcUPGUI8A5Q16NoTesLDSQ1IgNPigisRKq0GAq", "object": "v2.money_management.transaction", "amount": { "value": -1000, "currency": "usd" }, "balance_impact": { "available": { "value": -1000, "currency": "usd" }, "inbound_pending": { "value": 0, "currency": "usd" }, "outbound_pending": { "value": 0, "currency": "usd" } }, "category": "outbound_transfer", "created": "2023-03-24T22:06:37.343Z", "financial_account": "fa_65NvnnT0stRlwPDg2kc16NoTesLDSQ1IgNPigisRKq00Km", "flow": { "outbound_transfer": "obt_65NygiAXfaPmQ5ev3oz16NoTesLDSQ1IgNPigisRKq07Fg", "type": "outbound_transfer" }, "status": "posted", "status_transitions": { "posted_at": "2023-03-24T22:06:35.409Z", "void_at": null }}Returns a list of Transactions that match the provided filters.
Learn more about calling API v2 endpoints.Parameters
- createdtimestamp
Filter for Transactions created at an exact time.
- created_
gttimestamp Filter for Transactions created after the specified timestamp.
- created_
gtetimestamp Filter for Transactions created at or after the specified timestamp.
- created_
lttimestamp Filter for Transactions created before the specified timestamp.
- created_
ltetimestamp Filter for Transactions created at or before the specified timestamp.
- financial_
accountstring Filter for Transactions belonging to a FinancialAccount.
- flowstring
Filter for Transactions corresponding to a Flow.
- limitinteger
The page limit.
- pagestring
The page token.
Returns
Response attributes
- dataarray of objects
List of Transaction objects.
- next_
page_ urlnullable string The next page URL.
- previous_
page_ urlnullable string The previous page URL.
The resource wasn’t found.
{ "data": [ { "id": "trxn_65NygiBHKcUPGUI8A5Q16NoTesLDSQ1IgNPigisRKq0GAq", "object": "v2.money_management.transaction", "amount": { "value": -1000, "currency": "usd" }, "balance_impact": { "available": { "value": -1000, "currency": "usd" }, "inbound_pending": { "value": 0, "currency": "usd" }, "outbound_pending": { "value": 0, "currency": "usd" } }, "category": "outbound_transfer", "created": "2023-03-24T22:06:37.343Z", "financial_account": "fa_65NvnnT0stRlwPDg2kc16NoTesLDSQ1IgNPigisRKq00Km", "flow": { "outbound_transfer": "obt_65NygiAXfaPmQ5ev3oz16NoTesLDSQ1IgNPigisRKq07Fg", "type": "outbound_transfer" }, "status": "posted", "status_transitions": { "posted_at": "2023-03-24T22:06:35.409Z", "void_at": null } }, { "id": "trxn_65NygdWJ4oXvPH8YeYq16NoTesLDSQ1IgNPigisRKq0Flo", "object": "v2.money_management.transaction", "amount": { "value": 1000, "currency": "usd" }, "balance_impact": { "available": { "value": 1000, "currency": "usd" }, "inbound_pending": { "value": 0, "currency": "usd" }, "outbound_pending": { "value": 0, "currency": "usd" } }, "category": "received_credit", "created": "2023-03-24T22:01:48.394Z", "financial_account": "fa_65NygYWKxfJHZ49zLiX16NoTesLDSQ1IgNPigisRKq0Vqy", "flow": { "received_credit": "rc_61NygdVsGgIDm9k6816NoTesLDSQ1IgNPigisRKq06Cu", "type": "received_credit" }, "status": "posted", "status_transitions": { "posted_at": "2023-03-24T22:01:46.107Z", "void_at": null } } ], "next_page_url": null, "previous_page_url": null}This is a list of all public thin events we currently send for updates to Transaction, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.