Sign in
Direct Debit

Find direct debit payment by ID

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

get/v1/directdebit/payments/{paymentId}

Path parameters

paymentIdstring required

Payment identifier

Response

OK

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