Sign in
Direct Debit

Create new Direct Debit payment

Create a new Direct Debit payment 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/payments

Request body

amountinteger required

amount in pence

referencestring required

payment reference

descriptionstring required

payment description

mandate_idstring

ID of the mandates being used to collect the payment

Example request

{
  "amount": 12000,
  "reference": "12345",
  "description": "New passport application",
  "mandate_id": "33890b55-b9ea-4e2f-90fd-77ae0e9009e2"
}

Response

Created

amountinteger
descriptionstring
referencestring
payment_idstring
payment_providerstring
created_datestring
mandate_idstring
provider_idstring

Example response

{
  "amount": 1200,
  "description": "Your Service Description",
  "reference": "your-reference",
  "payment_id": "hu20sqlact5260q2nanm0q8u93",
  "payment_provider": "worldpay",
  "created_date": "2016-01-21T17:15:000Z",
  "_links": {
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "mandate": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  }
}

Changes