---
title: "Get Direct Debits"
method: GET
path: "/data/v2/accounts/{account_id}/direct-debits"
tags: ["Direct Debits Raw Data"]
---

# Get Direct Debits

`GET /data/v2/accounts/{account_id}/direct-debits`

Get the direct debits for a specific account given an accountId.
The accountId can be found by making a call to the /accounts endpoint.  
Requires the following permissions: `direct_debits`

## Path parameters

- `account_id` string, uuid, required

## Query parameters

- `async` boolean
- `page` integer
- `size` integer
- `entity_id` string, uuid
- `meta` string

## Response `200`

OK

- DirectDebitsResult
  - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required — The status of the request
  - `results_id` string, uuid, required — The unique identifier for the request
  - `message` string, required — A message describing the status of the request
  - `meta` object, nullable — Meta information about the request
  - `timestamp` string, date-time, required — The datetime of when the request was made
  - `status_detail` StatusDetail, nullable
    - `granular_status_code` string, nullable — Granular status code
    - `status_additional_info` string, nullable — Additional information about the status
  - `refreshed_at` string, date-time, nullable — The datetime of when the data was refreshed
  - `type` string, nullable — The endpoint the original request was made to.
  - `data` DirectDebitsData, nullable
    - `type` 'direct-debits', required — The endpoint the original request was made to.
    - `page` PageMetadata — Metadata about the current page of results
      - `number` integer, required — The current page being returned by the API
      - `size` integer, required — The page size requested
      - `total_elements` integer, required — The total number of elements in all pages
      - `total_pages` integer, required — The total number of pages retrievable
      - `sort` string[] — Sort parameters applied to the results
    - `direct_debits` DirectDebit[] — List of direct debits for an Account
      - `entity_id` string, uuid — The unique identifier for the entity. Provided as a UUID.
      - `account_id` string — The account_id this direct debit is related to.
      - `direct_debit_id` string — A unique identifier of the direct debit resource. This identifier has no meaning to the account owner.
      - `name` string — This is the name of the regulated beneficiary entity that initiates the Direct Debit collection.
      - `status_code` 'ACTIVE' | 'INACTIVE' | 'UNSUPPORTED' — Specifies the status of the direct debit in code form.
      - `frequency` 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'ANNUAL' | 'FORTNIGHTLY' | 'DAILY' | 'WEEKLY' | 'NOT_KNOWN' | 'UNSUPPORTED' — Regularity with which direct debit instructions are to be created and processed.
      - `mandate_identification` string — Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
      - `previous_payment_date_time` string, date-time — Date of most recent direct debit collection.
      - `previous_payment_amount` CurrencyAmount
        - `currency` string, required — The ISO 3 letter currency code
        - `amount` number, required — The amount of money in the currency specified.

## Other responses

- `202` — Accepted (Asynchronous request)
- `400` — Bad Request
- `404` — Account or entity not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)