Skip to main content

​
Transaction Object

The Transaction object represents a bank account transaction retrieved through Account Information Services (AIS).

​
Properties

​
id
string
required
Unique identifier for the transaction (UUID)
​
accountId
string
required
The ID of the bank account this transaction belongs to (UUID)
​
amount
string
required
The transaction amount as a string
​
currency
string
required
The currency of the transaction (ISO 4217 code, 3 characters)
​
description
string
The description of the transaction as it appears on the bank statement
​
counterpartyName
string
The name of the counterparty (creditor or debtor) if available
​
timestamp
timestamp
required
The date and time 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 bank account transactions for a given data session. Returns transactions from the last 3 months. 
POST /api/service/data/transactions/list
Request
​
sessionId
string
required
The ID of the data session to retrieve transactions for
Response
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",
      "counterpartyName": "Amazon UK"
    },
    {
      "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",
      "counterpartyName": "Spotify AB"
    },
    {
      "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"
    }
  ]
}

​
Notes

  • This endpoint returns transactions from customer bank accounts accessed through open banking
  • The data is retrieved from the bank’s systems via the data session consent
  • Transaction history is typically limited to the last 3 months depending on the bank