---
title: "Get Account Direct Debits"
method: GET
path: "/accounts/{accountId}/direct-debits"
tags: ["Financial Data"]
---

# Get Account Direct Debits

`GET /accounts/{accountId}/direct-debits`

## Request

- Base URL: `https://api.yapily.com`
- URL: `https://api.yapily.com/accounts/{accountId}/direct-debits`
- Auth: HTTP basic

Returns the list of direct debits for an account.

Feature: `ACCOUNT_DIRECT_DEBITS`

## Path parameters

- `accountId` string, required

## Query parameters

- `limit` integer

## Headers

- `consent` string, required
- `sub-application` string, uuid

## Response `200`

Ok

- ApiListResponseOfDirectDebitResponse
  - `meta` ResponseListMeta
    - `tracingId` string
    - `count` integer
    - `pagination` Pagination
      - `totalCount` integer
      - `self` FilterAndSort
        - `from` string, date-time: __Optional__. The earliest date and time of resources / records that should be returned.
        - `before` string, date-time: __Optional__. The latest date and time of resources / records that should be returned.
        - `limit` integer: __Optional__. The maximum number of resources / records that should be returned.
        - `sort` 'date' | '-date': The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.
        - `offset` integer
        - `cursor` string
      - `next` Next
        - `from` string, date-time
        - `before` string, date-time
        - `limit` integer
        - `cursor` string
  - `data` DirectDebitResponse[]
    - `id` string
    - `statusDetails` PaymentStatusDetails
      - `status` 'PENDING' | 'FAILED' | 'DECLINED' | 'COMPLETED' | 'COMPLETED_SETTLEMENT_IN_PROCESS' | 'EXPIRED' | 'UNKNOWN' | 'ACTIVE' | 'INACTIVE': The status of the Payment. For more information, see [Payment Status](/guides/payments/payment-status/)
      - `statusReason` string
      - `statusReasonDescription` string
      - `statusUpdateDate` string, date-time
      - `multiAuthorisationStatus` MultiAuthorisation: Details the additional levels of authorisation which are required from, and being managed by, the `Institution`.
        - `status` string: __Mandatory__. Specifies the current status of the multi-authorisation flow.
        - `numberOfAuthorisationRequired` integer: __Mandatory__. Total number of authorisations required.
        - `numberOfAuthorisationReceived` integer: __Mandatory__. The total number of authorisations that have been received.
        - `lastUpdatedDateTime` string, date-time: __Mandatory__. Date and time of when the authorisation was last updated.
        - `expirationDateTime` string, date-time: __Mandatory__. Date and time by when the authorisation flow must be completed before it expires and the authorisation request is terminated.
      - `isoStatus` PaymentIsoStatus: The payment status code, as denoted by a 3-letter ISO 20022 code.
        - `code` 'ACCC' | 'ACCP' | 'ACSC' | 'ACSP' | 'ACTC' | 'ACWC' | 'ACWP' | 'RCVD' | 'PDNG' | 'RJCT' | 'CANC' | 'ACFC' | 'PATC' | 'PART' | 'ACCO': The ISO 20022 `PaymentStatusCode`.
        - `name` string: The full name of the ISO 20022 `PaymentStatusCode`.
    - `payeeDetails` DirectDebitPayee
      - `name` string: __Mandatory__. The account holder name.
    - `reference` string
    - `previousPaymentAmount` Amount: __Mandatory__. Monetary Amount.
      - `amount` number, required: __Mandatory__. The monetary value
      - `currency` string, required: __Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code
    - `previousPaymentDateTime` string, date-time
  - `links` object
  - `forwardedData` ResponseForwardedData[]
    - `headers` object
    - `url` string
  - `raw` RawResponse[]
    - `request` RawRequest
      - `method` string
      - `url` string
      - `requestInstant` string, date-time
      - `headers` object
      - `body` object
      - `bodyParameters` object
      - `startTime` string, date-time
      - `startedAt` string, date-time
    - `duration` string, iso8601
    - `headers` object
    - `resultCode` integer
    - `result` object
  - `paging` FilteredClientPayloadListDirectDebitResponse
    - `apiCall` ApiCall
    - `data` DirectDebitResponse[]
      - `id` string
      - `statusDetails` PaymentStatusDetails
        - `status` 'PENDING' | 'FAILED' | 'DECLINED' | 'COMPLETED' | 'COMPLETED_SETTLEMENT_IN_PROCESS' | 'EXPIRED' | 'UNKNOWN' | 'ACTIVE' | 'INACTIVE': The status of the Payment. For more information, see [Payment Status](/guides/payments/payment-status/)
        - `statusReason` string
        - `statusReasonDescription` string
        - `statusUpdateDate` string, date-time
        - `multiAuthorisationStatus` MultiAuthorisation: Details the additional levels of authorisation which are required from, and being managed by, the `Institution`.
          - `status` string: __Mandatory__. Specifies the current status of the multi-authorisation flow.
          - `numberOfAuthorisationRequired` integer: __Mandatory__. Total number of authorisations required.
          - `numberOfAuthorisationReceived` integer: __Mandatory__. The total number of authorisations that have been received.
          - `lastUpdatedDateTime` string, date-time: __Mandatory__. Date and time of when the authorisation was last updated.
          - `expirationDateTime` string, date-time: __Mandatory__. Date and time by when the authorisation flow must be completed before it expires and the authorisation request is terminated.
        - `isoStatus` PaymentIsoStatus: The payment status code, as denoted by a 3-letter ISO 20022 code.
          - `code` 'ACCC' | 'ACCP' | 'ACSC' | 'ACSP' | 'ACTC' | 'ACWC' | 'ACWP' | 'RCVD' | 'PDNG' | 'RJCT' | 'CANC' | 'ACFC' | 'PATC' | 'PART' | 'ACCO': The ISO 20022 `PaymentStatusCode`.
          - `name` string: The full name of the ISO 20022 `PaymentStatusCode`.
      - `payeeDetails` DirectDebitPayee
        - `name` string: __Mandatory__. The account holder name.
      - `reference` string
      - `previousPaymentAmount` Amount: __Mandatory__. Monetary Amount.
        - `amount` number, required: __Mandatory__. The monetary value
        - `currency` string, required: __Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code
      - `previousPaymentDateTime` string, date-time
    - `nextCursorHash` string
    - `nextLink` string
    - `pagingMap` object
    - `totalCount` integer
  - `tracingId` string

## Other responses

- `default`: Error Response

---

[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)