v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB

Direct Debits

Create a direct debit

Creates a direct debit mandate from paper mandate details.

post/budgets/{budgetId}/direct-debits

Path parameters

budgetIdstring uuid required

The ID of the budget to work with.

Example:775596ae-2624-40af-a9dc-9756110a4a03

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

referencestring required

The direct debit reference, which may be set by the originator.

processingDatestring

The processing date of the direct debit.

priorityinteger required

The payment priority when there are insufficient funds.

Example request

{
  "reference": "fre4r5tg",
  "processingDate": "2025-01-15",
  "priority": 2,
  "originator": {
    "id": "123456",
    "accountName": "Netflix Inc",
    "address": {
      "addressType": "ADDR",
      "streetName": "Upper Thames Street",
      "buildingNumber": "68",
      "buildingName": "Vintners Place",
      "postcode": "EC4V 3BJ",
      "city": "London",
      "countryCode": "GB"
    }
  }
}

Response

Created

idstring uuid required

The unique identifier of the direct debit.

budgetIdstring uuid required

The ID of the budget to work with.

referencestring required

The direct debit reference, which may be set by the originator.

status'ACTIVE' | 'CANCELLED' required

The status of the direct debit.

priorityinteger required

The payment priority when there are insufficient funds.

createdAtstring date-time required

The date the Resource was initially created. ISO 8601 format without milliseconds.

Example response

{
  "id": "775596ae-2624-40af-a9dc-9756110a4a03",
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "reference": "fre4r5tg",
  "status": "ACTIVE",
  "priority": 2,
  "originator": {
    "id": "123456",
    "accountName": "Netflix Inc",
    "address": {
      "addressType": "ADDR",
      "addressLine": "Vintners Place, 68, Upper Thames Street",
      "city": "London",
      "postcode": "EC4V 3BJ",
      "countryCode": "GB"
    }
  },
  "createdAt": "2019-08-24T14:15:22Z"
}