---
title: "Find Direct Debit payment by ID"
method: GET
path: "/v1/directdebit/payments/{paymentId}"
tags: ["Direct Debit"]
---

# Find Direct Debit payment by ID

`GET /v1/directdebit/payments/{paymentId}`

Return information about the Direct Debit payment. The Authorisation token needs to be specified in the 'Authorization' header as 'Authorization: Bearer YOUR_API_KEY_HERE'

## Path parameters

- `paymentId` string, required

## Response `200`

OK

- DirectDebitPayment
  - `amount` integer
  - `description` string
  - `reference` string
  - `payment_id` string
  - `payment_provider` string
  - `created_date` string
  - `mandate_id` string
  - `provider_id` string
  - `_links` DirectDebitPaymentLinks — links for payment
    - `self` Link — A link related to a payment
      - `href` string
      - `method` string
    - `mandate` Link — A link related to a payment
      - `href` string
      - `method` string
  - `state` DirectDebitPaymentState
    - `details` string
    - `status` string

## Other responses

- `401` — Credentials are required to access this resource
- `404` — Not found
- `429` — Too many requests
- `500` — Downstream system error

## Changes

- **2019-10-08** `6d52e43c48aa` — 4 breaking, 2 info
  - removed the media type `application/json` for the response with the status `200`
  - removed the media type `application/json` for the response with the status `404`
  - removed the media type `application/json` for the response with the status `429`
  - removed the media type `application/json` for the response with the status `500`
  - …2 more
- **2019-10-06** `884c555517bc` — 6 info
  - the endpoint scheme security `BearerAuth` was added to the API
  - the endpoint scheme security `Authorization` was removed from the API
  - added the media type `application/json` for the response with the status `200`
  - added the media type `application/json` for the response with the status `404`
  - …2 more
- **2019-08-01** `6e01c8022b87` — 1 info
  - api operation id `Get a direct debit payment` removed and replaced with `Get a Direct Debit payment`
- **2019-07-31** `f8066d82895d` — 1 info
  - api operation id `getDirectDebitPayment` removed and replaced with `Get a direct debit payment`
- **2019-07-31** `ef50a2b1c4f1` — 1 info
  - api tag `Direct Debit` added

[Full history](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/changes/v1/directdebit/payments/:paymentId/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/11b29529cd78?raw)