---
title: "Get Categorised Transactions (Deprecated)"
method: GET
path: "/accounts/{accountId}/transactions/categorisation/{categorisationId}"
tags: ["Data Plus"]
deprecated: true
---

# Get Categorised Transactions (Deprecated)

`GET /accounts/{accountId}/transactions/categorisation/{categorisationId}`

## Request

- Base URL: `https://api.yapily.com`
- URL: `https://api.yapily.com/accounts/{accountId}/transactions/categorisation/{categorisationId}`
- Auth: HTTP basic

> **Deprecated.**

__Deprecated__. Retrieve categorised transactions by Categorisation ID.

Use the [other endpoint (`/transactions/categorisation/{categorisationId}`)](#operation/get-transactions-categorised) instead.

## Response `200`

OK

- ApiResponseOfGetCategorisedTransactionsRequest
  - `meta` object
    - `tracingId` string
    - `count` integer: Total number of categorised transactions available
    - `pageCount` integer: Total number of pages available, calculated based on the limit per page sent in the request.
  - `data` object
    - `transactions` object[], required
      - `enrichment` object, required: Enrichment/Categorisation data
        - `transactionHash` object, required: A unique identifier for the transaction that was generated by Yapily. It is a hash of some transaction attributes that is useful when no other identifier is present for instance.
          - `hash` string, required
        - `categorisation` object, required: Categories associated with the transaction (see [categories list](/data/data-plus/categorisation-list))
          - `categories` string[], required
        - `merchant` object: Processed merchant information
          - `id` string: The unique identifier for the merchant
          - `name` string: The familiar name of the merchant (eg. 'Waitrose', 'Uber')
          - `logo` string: The logo of the merchant, formatted as a URL
      - `recurrence` string: Processed type of recurrence for the transaction (eg. 'one off', 'subscription')
      - `paymentProcessor` string: Processed payment provider for the transaction (eg. 'PayPal')
      - `location` string: Processed location of the transaction/merchant derived from the transaction's description, formatted as an address
      - `merchant` object: Generic merchant information
        - `merchantCategoryCode` string: An ISO 18245 code specifying the goods and services that the merchant provides (eg. `5411` for Grocery Stores and Supermarkets)
      - `id` string: __Conditional.__ An identifier for the transaction retrieved from Yapily AIS (ie. present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation))
      - `date` string, date-time, required: The date and time when the transaction happened
      - `description` string, required: The description associated with the transaction
      - `transactionAmount` object, required: The amount associated with the transaction
        - `amount` number, required: The monetary amount (a positive value implies _incoming_ transaction and a negative value implies _outgoing_ transaction)
        - `currency` string, required: The [ISO 4217](https://www.xe.com/iso4217.php) currency code
      - `bookingDateTime` string, date-time: __Conditional.__ The date and time when the transaction was booked This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
      - `valueDateTime` string, date-time: __Conditional.__ The date and time when the funds either cease to be available (for _outgoing_ transactions) or become available to the account owner (for _incoming_ transactions) This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
      - `status` string: __Conditional.__ The status of the transaction. Enum: `BOOKED`, `PENDING` This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
      - `amount` number: __Conditional.__ The monetary amount (a positive value implies _incoming_ transaction and a negative value implies _outgoing_ transaction) This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
      - `currency` string: __Conditional.__ The [ISO 4217](https://www.xe.com/iso4217.php) currency code This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
      - `reference` string: __Conditional.__ The reference associated with the transaction This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
      - `transactionInformation` string[]: __Conditional.__ Other details associated with the transaction. This is narrative data, caught as unstructured text. This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
      - `proprietaryBankTransactionCode` object: __Conditional.__ A transaction code that is proprietary to the issuer institution This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
        - `code` string
        - `issuer` string
      - `isoBankTransactionCode` object: __Conditional.__ The ISO 20022 codes specifying the type of the transaction (eg. domain of 'Payments', family of 'Issued Credit Transfers', and sub-family of 'Domestic Credit Transfer') This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
        - `domainCode` object: The domain of the transaction
          - `code` string: Unique identifier of the ISO code
          - `name` string: Name of the ISO code
        - `familyCode` object: The family of the transaction
          - `code` string: Unique identifier of the ISO code
          - `name` string: Name of the ISO code
        - `subFamilyCode` object: The sub-family of the transaction
          - `code` string: Unique identifier of the ISO code
          - `name` string: Name of the ISO code
      - `balance` object: __Conditional.__ The account balance around the time of the transaction (the exact timing is dictated by the balance type) This may be present when using [Transactions and Categorisation endpoint](/api-reference/post-accounts-accountId-transactions-categorisation)
        - `type` string: Enum: `CLOSING_AVAILABLE`, `CLOSING_BOOKED`, `CLOSING_CLEARED`, `EXPECTED`, `FORWARD_AVAILABLE`, `INFORMATION`, `INTERIM_AVAILABLE`, `INTERIM_BOOKED`, `INTERIM_CLEARED`, `OPENING_AVAILABLE`, `OPENING_BOOKED`, `OPENING_CLEARED`, `PREVIOUSLY_CLOSED_BOOKED`, `AUTHORISED`, `OTHER`, `UNKNOWN`
        - `balanceAmount` object
          - `amount` integer
          - `currency` string
  - `links` object
    - `first` string
    - `prev` string
    - `self` string
    - `next` string
    - `last` string

## Other responses

- `400`: Validation Error
- `401`: Authentication Error
- `404`: Categorisation ID not found
- `500`: Unexpected Error

---

[API](https://skmtc.dev/yapily/apis/yapily-api.md) - [All operations](https://skmtc.dev/yapily/apis/yapily-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yapily/apis/yapily-api/revisions/a8ca54f9eb9f?raw)