Direct Debit Mandates

Get the direct debit mandate with the specified identifier

get/api/v2/direct-debit/mandates/{mandateUid}

Path parameters

mandateUidstring uuid required

Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Unique identifier of the mandate.

Response

Successful operation

uidstring uuid

referencestring

status'CANCELLED' | 'LIVE' | 'PENDING_CAS'

source'ELECTRONIC' | 'PAPER'

createdstring date-time

cancelledstring date-time

nextDatestring date

lastDatestring date

originatorNamestring

originatorUidstring uuid

merchantUidstring uuid

accountUidstring uuid

categoryUidstring uuid

Example response

{
  "uid": "eeffeeff-eeff-eeff-eeff-eeffeeffeeff",
  "reference": "Accommodation",
  "status": "LIVE",
  "source": "ELECTRONIC",
  "created": "2019-04-16T11:47:50.477Z",
  "nextDate": "2020-04-16",
  "lastDate": "2020-03-16",
  "originatorName": "University Of Warwick",
  "originatorUid": "ff11ff11-ff11-ff11-ff11-ff11ff11ff11",
  "merchantUid": "80ba691d-10a6-432c-90be-6ceaf932410e",
  "lastPayment": {
    "lastDate": "2020-03-16",
    "lastAmount": {
      "currency": "GBP",
      "minorUnits": 123456
    }
  },
  "accountUid": "323ac478-11a7-232d-90ae-7ceaf832330e"
}