Transaction Accounts

Transaction accounts are the entities that hold the balances of clients or organization. Each transaction account may be connected to a bank account. Some transaction accounts, such as wallets, may not be connected to any bank account. Each transaction account has a ledger account that holds the ledger entries. Transaction accounts also hold outgoing transfer schemes and incoming transfer schemes.

Get a Transaction Account

GET /transaction-accounts/{id}

{
  "workflow": {},
  "data": {
    "transactionAccount": {
      "id": "00000000-0000-0000-0000-000000000000",
      "clientId": null,
      "bankAccountId": "00000000-0000-0000-0000-000000000000",
      "currency": "EUR",
      "availableBalance": 20,
      "inboundTransferSchemes": [
        "swift",
        "sepa",
        "sepa-instant"
      ],
      "outboundTransferSchemes": [
        "swift",
        "sepa",
        "sepa-instant"
      ],
      "status": "active",
      "depositInformation": {
        "sepa": {
          "country": "GB",
          "iban": "GB03LHVB04032800006654",
          "routingCodes": {
            "bic": "LHVBGB2L"
          }
        },
        "swift": {
          "country": "GB",
          "iban": "GB03LHVB04032800006654",
          "routingCodes": {
            "bic": "LHVBGB2L"
          }
        },
        "sepa-instant": {
          "country": "GB",
          "iban": "GB03LHVB04032800006654",
          "routingCodes": {
            "bic": "LHVBGB2L"
          }
        }
      }
    }
  },
  "connect": {},
  "metadata": {}
}

List Transaction Accounts

GET /transaction-accounts

Supported query parameters:

parameter	description
metadata.page.number	0-indexed, default=0
metadata.page.size	default=10
data.transactionAccount.clientId	UUID of client
data.transactionAccount.status	one of active, inactive
data.transactionAccount.currency	ISO 4217 currency code
data.transactionAccount.bankAccountId	UUID of bank account
data.transactionAccount.routingCodeKey	routing code key
data.transactionAccount.routingCodeValue	routing code value
data.transactionAccount.iban	iban
data.transactionAccount.accountNumber	account number
data.transactionAccount.availableBalanceFrom
data.transactionAccount.availableBalanceTo

{
  "workflow": {},
  "data": {
    "transactionAccounts": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "clientId": null,
        "bankAccountId": "00000000-0000-0000-0000-000000000000",
        "currency": "HUF",
        "availableBalance": 50,
        "inboundTransferSchemes": [
          "swift"
        ],
        "outboundTransferSchemes": [
          "swift",
          "local"
        ],
        "status": "active",
        "depositInformation": {
          "swift": {
            "country": "GB",
            "iban": "GB60TCCL12345610395112",
            "routingCodes": {
              "bic": "TCCLGB3L"
            }
          }
        }
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "clientId": null,
        "bankAccountId": "00000000-0000-0000-0000-000000000000",
        "currency": "SEK",
        "availableBalance": 30,
        "inboundTransferSchemes": [
          "swift"
        ],
        "outboundTransferSchemes": [
          "swift",
          "local"
        ],
        "status": "active",
        "depositInformation": {
          "swift": {
            "country": "GB",
            "iban": "GB74TCCL12345604865957",
            "routingCodes": {
              "bic": "TCCLGB3L"
            }
          }
        }
      }
    ]
  },
  "connect": {},
  "metadata": {
    "page": {
      "size": 10,
      "number": 0,
      "totalElements": 2,
      "totalPages": 1
    }
  }
}

Get Transaction Account Statements

GET /transaction-accounts//{id}/account-statements

Listing transaction account statements with request filter parameters.

parameter	description
metadata.page.number	Requested page number: 0-indexed, default=0
metadata.page.size	Number of entries for each page: default=10
data.transactionAccountStatement.accountId	UUID of transaction account
data.transactionAccountStatement.transactionNumber	Transaction number for a specific statement record. format: 20201231-QWERTY
data.transactionAccountStatement.entryDateTimeFrom	Transaction entry in range from date. format: 2020-12-31T00:00:00.000
data.transactionAccountStatement.entryDateTimeTo	Transaction entry in range to date. format: 2020-12-31T00:00:00.000

The default date range is the current month's from the first day to the last day.
If fromDate is given and toDate is empty, then default toDate is the last day of the fromDate's month.
If toDate is given and fromDate is empty, then default fromDate is the first day of the toDate's month.

{
  "workflow": {},
  "data": {
    "transactionAccountStatements": [
      {
        "accountId": "00000000-0000-0000-0000-000000000000",
        "transactionNumber": "20240909-9JW8W7",
        "transactionType": "exchange-transaction",
        "entryType": "principal-sell",
        "entryDateTime": "2024-09-09T07:46:38.290176",
        "direction": "debit",
        "amount": 12.00,
        "balance": 7805.00,
        "currency": "GBP",
        "narrative": "Sold to buy EUR at EUR/GBP:1.182"
      },
      {
        "accountId": "00000000-0000-0000-0000-000000000000",
        "transactionNumber": "20240909-9JW8W7",
        "transactionType": "exchange-transaction",
        "entryType": "principal-sell",
        "entryDateTime": "2024-09-09T07:46:39.792114",
        "direction": "credit",
        "amount": 12.00,
        "balance": 7817.00,
        "currency": "GBP",
        "narrative": "Reversal of Sold to buy EUR at EUR/GBP:1.182"
      }
    ]
  },
  "connect": {},
  "metadata": {
    "page": {
      "size": 20,
      "number": 0,
      "totalElements": 2,
      "totalPages": 1
    }
  }
}

Enum values of Transaction Account Statements:

Field Code	Possible Values
direction	debit, credit
transactionType	incoming-transfer, outgoing-transfer, exchange-transaction, balance-adjustment
entryType	incoming-transfer: principal, fee outgoing-transfer: principal, fee exchange-transaction: principal-sell, principal-buy, fee, cancellation-fee balance-adjustment: principal

Webhooks

Transaction Account Webhooks: Transaction Account webhooks have "transaction-accounts" in the module field in the webhook container object.
There are 3 types of webhooks sent for transaction accounts:
- transaction-account-created
- transaction-account-activated
- transaction-account-inactivated
These types are exposed in the webhook.type field.

{
   "webhook":{
      "module":"transaction-accounts",
      "type":"transaction-account-created"
   },
   "data":{
      "transactionAccount":{
         "id":"00000000-0000-0000-0000-000000000000",
         "clientId":null,
         "bankAccountId":"00000000-0000-0000-0000-000000000000",
         "currency":"SEK",
         "availableBalance":40,
         "inboundTransferSchemes":[
            "swift"
         ],
         "outboundTransferSchemes":[
            "swift",
            "local"
         ],
         "status":"active",
         "depositInformation":{
            "swift":{
               "country":"GB",
               "iban":"GB74TCCL12345604865957",
               "routingCodes":{
                  "bic":"TCCLGB3L"
               }
            }
         }
      }
   },
   "connect":{

   },
   "metadata":{

   }
}

{
   "webhook":{
      "module":"transaction-accounts",
      "type":"transaction-account-activated"
   },
   "data":{
      "transactionAccount":{
         "id":"00000000-0000-0000-0000-000000000000",
         "clientId":null,
         "bankAccountId":"00000000-0000-0000-0000-000000000000",
         "currency":"SEK",
         "availableBalance":10,
         "ledgerAccountId":"00000000-0000-0000-0000-000000000000",
         "inboundTransferSchemes":[
            "swift"
         ],
         "outboundTransferSchemes":[
            "swift",
            "local"
         ],
         "status":"active",
         "depositInformation":{
            "swift":{
               "country":"GB",
               "iban":"GB74TCCL12345604865957",
               "routingCodes":{
                  "bic":"TCCLGB3L"
               }
            }
         }
      }
   },
   "connect":{

   },
   "metadata":{

   }
}

{
   "webhook":{
      "module":"transaction-accounts",
      "type":"transaction-account-inactivated"
   },
   "data":{
      "transactionAccount":{
         "id":"00000000-0000-0000-0000-000000000000",
         "clientId":null,
         "bankAccountId":"00000000-0000-0000-0000-000000000000",
         "currency":"SEK",
         "availableBalance":30,
         "ledgerAccountId":"00000000-0000-0000-0000-000000000000",
         "inboundTransferSchemes":[
            "swift"
         ],
         "outboundTransferSchemes":[
            "swift",
            "local"
         ],
         "status":"inactive",
         "depositInformation":{
            "swift":{
               "country":"GB",
               "iban":"GB74TCCL12345604865957",
               "routingCodes":{
                  "bic":"TCCLGB3L"
               }
            }
         }
      }
   },
   "connect":{

   },
   "metadata":{

   }
}