Direct Debit Bulk Actions & Payment Control Enhancements

Overview

This release introduces new bulk management endpoints for Direct Debit Requests (DDRs), enabling merchants and developers to perform mass amount adjustments and send bulk payment account update links. Additionally, merchant payment settings have been updated to support granular card payment controls across different payment flows.

Bulk Direct Debit API Enhancements

Overview

To support automated account management and surcharge transition workflows, two new POST endpoints allow for batch processing of Direct Debit Requests. Both operations handle errors gracefully on an item-by-item basis, returning an execution report rather than failing the entire request batch.

API Changes

Bulk Amount Adjustments

• POST /direct_debit_amount_adjustments – Batch-update the recurring amount for up to 500 direct debits by either a fixed dollar amount or a percentage.

Request Parameters:

• Codes (string[], max 500) – Array of Direct Debit codes to adjust.
• AdjustmentType (string) – percentage | fixed_amount.
• Value (decimal) – Adjustment value (max 10 when AdjustmentType is percentage).
• SuppressCustomerNotification (bool) – Set to true to opt out of sending automated email notifications to affected customers.

Response Schema:

• Results (array) – List of outcomes per Direct Debit code:
  • Code (string)
  • Applied (bool)
  • Reason (string, optional) – Reason for skipping (e.g. pending re-authorisation).
  • RecurringAmount (decimal, optional) – Updated amount if successfully applied.

Bulk Send Change Account Links

• POST /direct_debit_account_change_requests – Dispatch payment-detail update links via email/SMS to customers linked to the specified direct debits.

Request Parameters:

• Codes (string[], min 1, max 500) – Array of Direct Debit codes to trigger change-account links for.

Response Schema (BulkDirectDebitAccountChangeResponse):

• Results (array) – Status array detailing execution per requested debit:
  • Code (string)
  • Sent (bool)
  • Reason (string, optional) – Populated when Sent is false (e.g., debit pending re-authorisation, or customer lacking email/mobile contact info).

Behaviour Notes:

• Notification Consolidation: Links are created per Customer Payment Account. Direct debits sharing the same payment account are consolidated into a single notification email or SMS.
• Eligibility: Only debits in active or paused states are eligible.