A Transaction represents a real transaction that affects a Financial Connections Account balance.
Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- accountstring
The ID of the Financial Connections Account this transaction belongs to.
- amountinteger
The amount of this transaction, in cents.
- currencystring
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- descriptionstring
The description of this transaction.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - statusenum
The status of the transaction.
Possible enum valuespending
This transaction is processing and does not yet affect the account’s balance.
posted
This transaction has processed and affects the account’s balance.
void
This transaction has disappeared and no longer affects the account’s balance.
- status_
transitionsobject The timestamps at which the transaction status was updated.
- transacted_
attimestamp Time at which the transaction was transacted. Measured in seconds since the Unix epoch.
- transaction_
refreshstring The token of the transaction refresh that last updated or created this transaction.
- updatedtimestamp
Time at which the object was last updated. Measured in seconds since the Unix epoch.
{ "id": "fctxn_1MwVKd2eZvKYlo2ChNw2UxSa", "object": "financial_connections.transaction", "account": "fca_1MwVKd2eZvKYlo2CnlgoF3I4", "amount": 300, "currency": "usd", "description": "Rocket Rides", "livemode": false, "status": "posted", "status_transitions": { "posted_at": 1681412239, "void_at": null }, "transacted_at": 1681412239, "transaction_refresh": "fctxnref_NhvAgiKSFDg9jOe6eIlj41X5", "updated": 1681412239}
Retrieves the details of a Financial Connections Transaction
Parameters
No parameters.
Returns
Returns a Transaction
object if a valid identifier was provided, and raises an error otherwise.
{ "id": "fctxn_1MwVKd2eZvKYlo2ChNw2UxSa", "object": "financial_connections.transaction", "account": "fca_1MwVKd2eZvKYlo2CnlgoF3I4", "amount": 300, "currency": "usd", "description": "Rocket Rides", "livemode": false, "status": "posted", "status_transitions": { "posted_at": 1681412239, "void_at": null }, "transacted_at": 1681412239, "transaction_refresh": "fctxnref_NhvAgiKSFDg9jOe6eIlj41X5", "updated": 1681412239}
Returns a list of Financial Connections Transaction
objects.
Parameters
- accountstringRequired
The ID of the Financial Connections Account whose transactions will be retrieved.
- transacted_
atobject A filter on the list based on the object
transacted_
field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:at - transaction_
refreshobject A filter on the list based on the object
transaction_
field. The value can be a dictionary with the following options:refresh
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
Transaction
objects, 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/financial_connections/transactions", "has_more": false, "data": [ { "id": "fctxn_1NpHiT2eZvKYlo2CZFvnM3HJ", "object": "financial_connections.transaction", "account": "fca_1NpHiT2eZvKYlo2C6pRwOFjr", "amount": 300, "currency": "usd", "description": "Rocket Rides", "livemode": false, "status": "posted", "status_transitions": { "posted_at": 1694467941, "void_at": null }, "transacted_at": 1694467941, "transaction_refresh": "fctxnref_OcWmGrWptAdJ2bmpYE2P0Hws", "updated": 1694467941 } ]}
A Tax Calculation allows you to calculate the tax to collect from your customer.
Related guide: Calculate tax in your custom payment flow