Webhook events

Subscribe to Direct Debit webhook events to receive real-time notifications about mandate activity.

DirectDebitCreated

A new Direct Debit mandate has been created.

Sample payload

{
  "body": {
    "accountId": "F12345",
    "budgetId": "4db84122-9c4e-4607-98f7-84b2bbe02daf",
    "directDebitId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "reference": "NETFLIXSUB123",
    "messageId": "66854098-aac7-4084-938e-bc2e62fb6a44",
    "webhookEventTypeName": "DirectDebitCreated"
  }
}

Event fields

Field	Type	Description
`accountId`	string	The ID of the account
`budgetId`	string	The ID of the budget associated with the Direct Debit
`directDebitId`	string	The ID of the newly-created Direct Debit (valid UUID)
`reference`	string	The Direct Debit reference (≤ 18 characters)
`messageId`	string	The ID of the specific webhook event message. We’ll keep retrying to send an event with the same `messageId` until we receive a `200` response (36 characters)
`webhookEventTypeName`	string	The name of the webhook event type: `DirectDebitCreated`

DirectDebitCancelled

A Direct Debit mandate has been cancelled.

Sample payload

{
  "body": {
    "accountId": "F12345",
    "budgetId": "4db84122-9c4e-4607-98f7-84b2bbe02daf",
    "directDebitId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "reference": "NETFLIXSUB123",
    "messageId": "66854098-aac7-4084-938e-bc2e62fb6a44",
    "webhookEventTypeName": "DirectDebitCancelled"
  }
}

Event fields

Field	Type	Description
`accountId`	string	The ID of the account
`budgetId`	string	The ID of the budget associated with the Direct Debit
`directDebitId`	string	The ID of the cancelled Direct Debit (valid UUID)
`reference`	string	The Direct Debit reference (≤ 18 characters)
`messageId`	string	The ID of the specific webhook event message. We’ll keep retrying to send an event with the same `messageId` until we receive a `200` response (36 characters)
`webhookEventTypeName`	string	The name of the webhook event type: `DirectDebitCancelled`

DirectDebitPaymentRejected

A Direct Debit collection has been rejected and won’t be paid. We don’t send this event when a collection can’t be matched to a Direct Debit on the account (reason codes 5, 6 and A). If the collection is the fourth rejected in a row, we also cancel the Direct Debit and send a DirectDebitCancelled event. The two events can arrive in either order.

Sample payload

{
  "body": {
    "accountId": "F12345",
    "budgetId": "4db84122-9c4e-4607-98f7-84b2bbe02daf",
    "directDebitId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "payRequestId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "reference": "NETFLIXSUB123",
    "amount": 45.99,
    "currencyCode": "GBP",
    "originator": {
      "id": "123456",
      "accountName": "Example Streaming Ltd",
      "bankIdentifier": "123456",
      "accountIdentifier": "12345678"
    },
    "rejectedAt": "2026-10-14T09:30:00.000Z",
    "reasonCode": "0",
    "reason": "Refer to payer",
    "messageId": "66854098-aac7-4084-938e-bc2e62fb6a44",
    "webhookEventTypeName": "DirectDebitPaymentRejected"
  }
}

Event fields

Field	Type	Description
`accountId`	string	The ID of the account
`budgetId`	string	The ID of the budget associated with the Direct Debit
`directDebitId`	string	The ID of the Direct Debit the collection was made against (valid UUID)
`payRequestId`	string	The ID of the rejected collection (valid UUID)
`reference`	string	The Direct Debit reference (≤ 18 characters)
`amount`	number	The amount of the rejected collection, in major units (for example, `45.99`)
`currencyCode`	string	The currency of the collection, as an ISO 4217 code
`originator`	object	The organisation that requested the collection
`originator.id`	string	The originator’s service user number
`originator.accountName`	string	The originator’s name
`originator.bankIdentifier`	string	The sort code of the originator’s account
`originator.accountIdentifier`	string	The account number of the originator’s account
`rejectedAt`	string	When the collection was rejected (ISO 8601, UTC)
`reasonCode`	string	The Bacs reason code for the rejection. See Reason codes
`reason`	string \| null	A description of the reason code, or `null` if the code isn’t listed below
`messageId`	string	The ID of the specific webhook event message. We’ll keep retrying to send an event with the same `messageId` until we receive a `200` response (36 characters)
`webhookEventTypeName`	string	The name of the webhook event type: `DirectDebitPaymentRejected`

Reason codes

Code	Reason
`0`	Refer to payer
`1`	Instruction cancelled
`2`	Payer deceased
`4`	Advance notice disputed
`8`	Amount not yet due
`B`	Account closed

Get started

Accounts & onboarding

Budgets

Payments

Cards

Transactions

Reports

People

Webhooks

Roqqett

DirectDebitCreated

Sample payload

Event fields

DirectDebitCancelled

Sample payload

Event fields

DirectDebitPaymentRejected

Sample payload

Event fields

Reason codes

​DirectDebitCreated

​Sample payload

​Event fields

​DirectDebitCancelled

​Sample payload

​Event fields

​DirectDebitPaymentRejected

​Sample payload

​Event fields

​Reason codes

DirectDebitCreated

Sample payload

Event fields

DirectDebitCancelled

Sample payload

Event fields

DirectDebitPaymentRejected

Sample payload

Event fields

Reason codes