---
title: "Find mandate by ID"
method: GET
path: "/v1/directdebit/mandates/{mandateId}"
tags: ["Direct Debit"]
---

# Find mandate by ID

`GET /v1/directdebit/mandates/{mandateId}`

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

## Path parameters

- `mandateId` string, required

## Response `200`

OK

- MandateResponse
  - `mandate_id` string — mandate id
  - `provider_id` string — provider id
  - `reference` string — service reference
  - `return_url` string — service return url
  - `state` MandateStatus
    - `status` string
    - `details` string
  - `_links` MandateLinks — payment, events, self and next links of a Mandate
    - `self` Link — A link related to a payment
      - `href` string
      - `method` string
    - `next_url` Link — A link related to a payment
      - `href` string
      - `method` string
    - `next_url_post` PostLink — A POST link related to a payment
      - `type` string
      - `params` object
      - `href` string
      - `method` string
    - `payments` Link — A link related to a payment
      - `href` string
      - `method` string
  - `bank_statement_reference` string — This value comes from GoCardless when a mandate has been created.
  - `created_date` string — mandate created date
  - `description` string — description
  - `payment_provider` string — payment_provider
  - `payer` Payer
    - `name` string
    - `email` string

## Other responses

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

## Changes

- **2019-07-31** `f8066d82895d` — 1 info
  - api operation id `getMandate` removed and replaced with `Get a mandate`
- **2019-07-31** `ef50a2b1c4f1` — 1 info
  - api tag `Direct Debit` added
- **2019-07-25** `c7d45aee555b` — 1 info
  - the endpoint scheme security `Authorization` was added to the API
- **2019-07-18** `3a963e47bc48` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/alphagov/apis/gov-uk-pay-api/changes/v1/directdebit/mandates/:mandateId/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)