Use Transactions to view changes to your FinancialAccount balance over time. Every flow that moves money, such as OutboundPayments or ReceivedCredits, will have one or more Transactions that describes how the flow impacted your balance. Note that while the FinancialAccount balance will always be up to date, be aware that Transactions and TransactionEntries are created shortly after to reflect changes.
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 valuesadjustment
This 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.
return
This 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
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - statusenum
Current status of the Transaction. A Transaction is
pending
if eitherbalance_
orimpact. inbound_ pending balance_
is non-zero. A Transaction isimpact. outbound_ pending posted
if onlybalance_
is non-zero. A Transaction isimpact. available void
if there is no balance impact.posted
andvoid
are terminal states, and no additional entries will be added to the Transaction.Possible enum valuespending
This 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 posted
This Transaction’s balance impact is fully posted (only
cash
will be non-zero). This status is final and no further entries will be added.void
This 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.
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 valuesadjustment
This 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.
return
This 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
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - statusenum
Current status of the Transaction. A Transaction is
pending
if eitherbalance_
orimpact. inbound_ pending balance_
is non-zero. A Transaction isimpact. outbound_ pending posted
if onlybalance_
is non-zero. A Transaction isimpact. available void
if there is no balance impact.posted
andvoid
are terminal states, and no additional entries will be added to the Transaction.Possible enum valuespending
This 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 posted
This Transaction’s balance impact is fully posted (only
cash
will be non-zero). This status is final and no further entries will be added.void
This 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.
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 the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.
Event types
Attributes
- idstring
Unique identifier for the event.
- objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.
- contextnullable string
Authentication context needed to fetch the event or related object.
- createdtimestamp
Time at which the object was created.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - reasonnullable object
Reason for the event.
- related_
objectnullable object Object containing the reference to API resource relevant to the event.
- typestring, value is "v2.money_management.transaction.created"
The type of the event.
Fetched attributes
- dataobject
Additional data about the event.
Attributes
- idstring
Unique identifier for the event.
- objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.
- contextnullable string
Authentication context needed to fetch the event or related object.
- createdtimestamp
Time at which the object was created.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - reasonnullable object
Reason for the event.
- related_
objectnullable object Object containing the reference to API resource relevant to the event.
- typestring, value is "v2.money_management.transaction.updated"
The type of the event.
Fetched attributes
- dataobject
Additional data about the event.