The Transaction object
Attributes
- id string Unique identifier for the object.
- object string, value is "financial_connections.transaction" String representing the object’s type. Objects of the same type share the same value.
- account string The ID of the Financial Connections Account this transaction belongs to.
- amount integer The amount of this transaction, in the smallest currency unit.
- currency string Three-letter ISO currency code, in lowercase. Must be a supported currency.
- description string The description of this transaction.
- livemode boolean If the object exists in live mode, the value is
true. If the object exists in test mode, the value isfalse. - status enum The status of the transaction. Possible enum values
pendingThis transaction is processing and does not yet affect the account’s balance.postedThis transaction has processed and affects the account’s balance.voidThis transaction has disappeared and no longer affects the account’s balance. - status _ transitions object The timestamps at which the transaction status was updated.
- transacted _ at timestamp Time at which the transaction was transacted. Measured in seconds since the Unix epoch.
- transaction _ refresh string The token of the transaction refresh that last updated or created this transaction.
- updated timestamp Time at which the object was last updated. Measured in seconds since the Unix epoch.
The Transaction object
{ "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}
Retrieve a Transaction
GET / v1 / financial_connections / transactions /:id
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.
Response
{ "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}
List Transactions
GET / v1 / financial_connections / transactions
Returns a list of Financial Connections Transaction objects.
Parameters
- account string Required The ID of the Financial Connections Account whose transactions will be retrieved.
- transacted _ at object A filter on the list based on the object
transacted_atfield. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options: - transaction _ refresh object A filter on the list based on the object
transaction_refreshfield. The value can be a dictionary with the following options:
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 Transaction objects, 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
