Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt

Use this file to discover all available pages before exploring further.

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

FieldTypeDescription
accountIdstringThe ID of the account
budgetIdstringThe ID of the budget associated with the Direct Debit
directDebitIdstringThe ID of the newly-created Direct Debit (valid UUID)
referencestringThe Direct Debit reference (≤ 18 characters)
messageIdstringThe 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)
webhookEventTypeNamestringThe 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

FieldTypeDescription
accountIdstringThe ID of the account
budgetIdstringThe ID of the budget associated with the Direct Debit
directDebitIdstringThe ID of the cancelled Direct Debit (valid UUID)
referencestringThe Direct Debit reference (≤ 18 characters)
messageIdstringThe 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)
webhookEventTypeNamestringThe name of the webhook event type: DirectDebitCancelled