Send a Bacs Direct Debit pre-notification

​

Send a Bacs Direct Debit pre-notification (advance notice) to a payer ahead of collecting funds from their account.

Body·
application/json

Bacs Direct Debit notification request

  • source_id
    Type: string Pattern: ^(src)_(\w{26})$
    required

    The ID of the Bacs Direct Debit instrument to notify against.

  • notification_type
    enum
    const:  
    advance_notice
    required

    The type of pre-notification being sent to the payer.

    values
    • advance_notice
  • collection_date
    Type: string Format: date
    required

    The date the funds will be collected from the payer's account, in the format yyyy-MM-dd.

  • amount
    Type: integer Format: int64
    min:  
    1
    required

    The amount to be collected, in the currency's minor unit.

  • currency
    Type: string
    min length:  
    3
    max length:  
    3
    required

    The three-letter ISO 4217 currency code of the collection.

  • customer_email
    Type: string Format: email
    required

    The email address of the payer that the pre-notification is sent to.

  • billing_descriptor
    Type: string
    max length:  
    25
    required

    The billing descriptor that appears on the payer's bank statement.

  • support_email
    Type: string Format: email
    required

    The support email address included in the pre-notification.

  • reference
    Type: string
    max length:  
    50

    A reference you can use to identify the collection.

  • support_phone
    Type: string

    The support phone number included in the pre-notification, in E.164 format.

Responses
  • application/json
  • 401

    Unauthorized

  • application/json
Request Example for post/apms/bacs/notifications
curl 'https://{prefix}.api.sandbox.checkout.com/apms/bacs/notifications' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "source_id": "src_wmlfc3zyhqzehihu7giusaaawu",
  "notification_type": "advance_notice",
  "collection_date": "2026-07-15",
  "amount": 4999,
  "currency": "GBP",
  "reference": "INV-12345",
  "customer_email": "customer@example.com",
  "billing_descriptor": "CHECKOUT",
  "support_email": "support@test.com",
  "support_phone": "+447700900123"
}'

{
  "event_id": "evt_lzr4csdtddwetactr6phd3kea4"
}

Pre-notification created successfully