---
title: "Search Direct Debit payments"
method: GET
path: "/v1/directdebit/payments"
tags: ["Direct Debit"]
---

# Search Direct Debit payments

`GET /v1/directdebit/payments`

Search Direct Debit payments by reference, state, mandate id, and 'from' and 'to' dates. The Authorisation token needs to be specified in the 'Authorization' header as 'Authorization: Bearer YOUR_API_KEY_HERE'

## Query parameters

- `reference` string
- `state` string
- `mandate_id` string
- `from_date` string
- `to_date` string
- `page` integer
- `display_size` integer

## Response `200`

OK

- DirectDebitSearchResponse
  - `total` integer
  - `count` integer
  - `page` integer
  - `results` DirectDebitConnectorPaymentResponse[]
    - `amount` integer
    - `state` DirectDebitPaymentState
      - `details` string
      - `status` string
    - `description` string
    - `reference` string
    - `mandate_id` string
    - `payment_id` string
    - `payment_provider` string
    - `created_date` string
    - `provider_id` string
  - `_links` SearchNavigationLinks — Links to navigate through pages
    - `self` Link — A link related to a payment
      - `href` string
      - `method` string
    - `first_page` Link — A link related to a payment
      - `href` string
      - `method` string
    - `last_page` Link — A link related to a payment
      - `href` string
      - `method` string
    - `prev_page` Link — A link related to a payment
      - `href` string
      - `method` string
    - `next_page` Link — A link related to a payment
      - `href` string
      - `method` string

## Other responses

- `401` — Credentials are required to access this resource
- `422` — Invalid parameter. See Public API documentation for the correct data formats
- `429` — Too many requests
- `500` — Downstream system error

## Changes

- **2019-08-01** `6e01c8022b87` — 1 info
  - api operation id `Search direct debit payments` removed and replaced with `Search Direct Debit payments`
- **2019-07-31** `f8066d82895d` — 1 info
  - api operation id `searchDirectDebitPayments` removed and replaced with `Search direct debit payments`
- **2019-07-31** `ef50a2b1c4f1` — 1 info
  - api tag `Direct Debit` added
- **2019-07-24** `8c9cfc1bfdd1` — 1 info
  - api operation id `searchPayments` removed and replaced with `searchDirectDebitPayments`
- **2019-07-19** `4752d7029174` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/changes/v1/directdebit/payments/get.md)

---

[API](https://skmtc.dev/alphagov/apis/gov-uk-pay-api.md) · [All operations](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/llms.txt) · [OpenAPI document](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/revisions/6e01c8022b87?raw)