Sign in
Direct Debit

Create a new mandate

Create a new mandate for the account associated to the Authorisation token. The Authorisation token needs to be specified in the 'Authorization' header as 'Authorization: Bearer YOUR_API_KEY_HERE'

post/v1/directdebit/mandates

Request body

return_urlstring required

mandate return url

referencestring required

mandate reference

descriptionstring

mandate description

Example request

{
  "return_url": "https://service-name.gov.uk/transactions/12345",
  "reference": "test_service_reference"
}

Response

Created

mandate_idstring

mandate id

provider_idstring

provider id

referencestring

service reference

return_urlstring

service return url

bank_statement_referencestring

This value comes from GoCardless when a mandate has been created.

created_datestring

mandate created date

descriptionstring

description

payment_providerstring

payment_provider

Example response

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

Changes