v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Direct Debits

List all direct debits

This endpoint will retrieve all direct debit payments associated with a direct debit mandate. You will need to enable PERM_BUSINESS_GET_DIRECT_DEBITS to use this endpoint.

get/v1/directdebits

Query parameters

mandateUuidstring required

The mandate UUID to retrieve

Response

Retrieve all direct debit payments associated with a direct debit mandate.

totalinteger

Number of direct debits found

Example response

{
  "total": 1,
  "directdebits": [
    {
      "directDebitUuid": "42de0705-e3f1-44fa-8c41-79973eb80eb2",
      "currency": {
        "code": "EUR",
        "description": "Euro"
      },
      "status": "RECIEVED",
      "type": "FIRST_COLLECTION",
      "mandateUUid": "f171b143-e3eb-47de-85a6-1c1f1108c701",
      "originatorReference": "VODA-123456",
      "originatorName": "Vodafone PLC",
      "originatorAlias": "Three",
      "directDebitReference": "VODA-ABC453-1",
      "targetIcan": 42,
      "targetPayeeId": 12,
      "amount": 100,
      "schemeRejectReason": "eg. Instruction cancelled by payer",
      "schemeRejectReasonCode": "for BACS (ARUDD) 0|1|2|3|5|6|7|8|9|A|B",
      "lastUpdated": "2016-12-15T22:56:05.937Z",
      "dateCreated": "2016-12-15T22:56:05.937Z"
    }
  ]
}