Transaction Object

The Transaction object represents a financial transaction on an account.

Properties

id
string
required

Unique identifier for the transaction

accountId
string
required

The ID of the account this transaction belongs to

value
number

The transaction amount

currency
string

The currency of the transaction (ISO 4217 code)

description
string

The description of the transaction as it appears on the statement

date
timestamp
required

The date when the transaction occurred

type
enum
required

The type of the transaction: - credit - Money coming into the account - debit - Money going out of the account

Endpoints

List Transactions

Returns a list of transactions for an account.

POST /api/service/data/transactions/list

Request

accountId
string
required

The ID of the account to list transactions for

limit
number

Maximum number of transactions to return (default 50, max 100)

skip
number

Skip the first n transactions

dateFrom
string

Start date for transactions (ISO 8601 format)

dateTo
string

End date for transactions (ISO 8601 format)

Response
{
    "transactions": [
        {
            "id": "26c9b200-9dd4-54cd-9cf2-3363312cd99f",
            "accountId": "bafab4a9-2532-5b78-8c6f-4b9b0ecb6302",
            "amount": "10.00",
            "currency": "GBP",
            "description": "Amazon purchase",
            "timestamp": "2024-07-12T09:04:23.414Z",
            "type": "debit"
        },
        {
            "id": "3f5f1295-68d6-5bcb-81f5-5a59b6d36316",
            "accountId": "e4a387be-81bd-5036-ac04-90366b6c0cb8",
            "amount": "1.00",
            "currency": "EUR",
            "description": "Monthly subscription",
            "timestamp": "2024-07-12T12:43:56.624Z",
            "type": "debit"
        },
        {
            "id": "97c4759c-dc0d-52c4-8417-76fef74d7734",
            "accountId": "e4a387be-81bd-5036-ac04-90366b6c0cb8",
            "amount": "10.00",
            "currency": "EUR",
            "description": "EUR balance topup",
            "timestamp": "2024-07-12T09:20:18.572Z",
            "type": "credit"
        },
        {
            "id": "491389e8-1ea1-5be5-9337-d135e9e4854e",
            "accountId": "bafab4a9-2532-5b78-8c6f-4b9b0ecb6302",
            "amount": "20.00",
            "currency": "GBP",
            "description": "GBP balance topup",
            "timestamp": "2024-07-11T14:14:57.063Z",
            "type": "credit"
        },
    ]
}