Sign in
Direct Debit

Search mandates

Searches for mandates with the parameters provided. The Authorisation token needs to be specified in the 'Authorization' header as 'Authorization: Bearer YOUR_API_KEY_HERE'

get/v1/directdebit/mandates

Query parameters

referencestring
statestring
bank_statement_referencestring
emailstring
namestring
from_datestring

From date of mandates to be searched (this date is inclusive). Example=2015-08-13T12:35:00Z

to_datestring

To date of mandates to be searched (this date is exclusive). Example=2015-08-13T12:35:00Z

pageinteger

Page number requested for the search, should be a positive integer (optional, defaults to 1)

display_sizeinteger

Number of results to be shown per page, should be a positive integer (optional, defaults to 500, max 500)

Response

OK

totalinteger
countinteger
pageinteger

Example response

{
  "results": [
    {
      "mandate_id": "jhjcvaiqlediuhh23d89hd3",
      "provider_id": "jhjcvaiqlediuhh23d89hd3",
      "reference": "jhjcvaiqlediuhh23d89hd3",
      "return_url": "https://service-name.gov.uk/transactions/12345",
      "_links": {
        "self": {
          "href": "https://an.example.link/from/payment/platform",
          "method": "GET"
        },
        "next_url": {
          "href": "https://an.example.link/from/payment/platform",
          "method": "GET"
        },
        "next_url_post": {
          "type": "application/x-www-form-urlencoded",
          "href": "https://an.example.link/from/payment/platform",
          "method": "POST"
        },
        "payments": {
          "href": "https://an.example.link/from/payment/platform",
          "method": "GET"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "first_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "last_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "prev_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "next_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  }
}

Changes