Get transactions by user

get https://{API_PREFIX}.open-finance.ai/v2/data/transactions

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

string

page to retrieve, used for pagination

limit

number

Max number of documents to retrieve

dateFrom

string

Specifies the starting date from which to retrieve transactions. If you use this you cant use limit

dateTo

string

Specifies the ending date until which to retrieve transactions. If you use this you cant use limit

includeDuplicates

integer

Specifies whether to return duplicates or not

sort

number

1 for ascending, -1 for descending

accountId

string

The accountId that the transactions are linked to

connectionId

string

The connectionId that the transactions are linked to

type

string

The type of the provider

providerId

string

The providerId that the transactions are linked to

Responses

Response body

object

string | null

Represents the total number of items that exists after full pagination. The max transactions per request is 500

items

array of objects

items

object

string

A unique identifier for the transaction

string

Secondary key for the transaction, indicating the specific type of transaction and related metadata.

userId

string

A unique identifier for the user

orgId

string

A unique identifier for the organization

connectionId

string

A unique identifier for the connection

accountId

string

A unique identifier for the account

providerId

string

A unique identifier for the provider

transactionProviderIdentifier

string

A unique identifier for the provider TX

accountNumber

string

A bank account number

status

string

The transaction status

entryReference

string

The entry reference sent from the provider

categoryCode

string

Code representing the category of the transaction (MCC code or other).

securityDetails

object

amount

object

description

object

category

object

Categorized TX label

changedCategory

object

Details about the changed category of the transaction.

installments

object

Details about installments.

type

string

Transaction type, NORMAL or INSTALLMENT

date

object

markupFee

object

merchantName

string

The name of the merchant involved in the transaction.

details

string

Detailed information about the transaction.

isInvoiced

boolean

Indicates whether the transaction is invoiced.

code

string

A code representing the transaction.

merchantAddress

object

classification

object

Details about the classification of the transaction.

changedClassification

object

Details about any changes in the classification of the transaction.

labels

array of strings

Labels associated with the transaction.

labels

balancePerEndDay

number

The balance at the end of the day for the transaction.

isDuplicate

boolean

Indicates if the transaction is a duplicate - when a user connects the same credit card from a bank provider and from a credit card
when not send includeDuplicates filter the default will be that no duplicate transactions will be returned
if the transactions for the user contains more than 500 items, duplicates will be returned regardless of the used filters

creditorAccount

object

debtorAccount

object

endToEndId

string

The end-to-end identifier of the transaction.
This field is crucial for transferring the reference number of the payment, ensuring traceability and consistency across different financial institutions and systems.

400

userId is not allowed in query for non-admin users

401

Unauthorized access - Invalid access token

403

Forbidden - Access token missing the required permissions to preform this action

404

Route or entity not found

500

Internal server error

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.open-finance.ai/v2/data/transactions \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Response