Sign in
Direct Debit

Search Direct Debit 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'

get/v1/directdebit/payments

Query parameters

referencestring

Your payment reference to search

statestring

State of payments to be searched. Example=success

mandate_idstring

The GOV.UK Pay identifier for the mandate

from_datestring

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

to_datestring

To date of direct debit payments 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

{
  "_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