v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Direct Debits

Bulk mandate cancellation request for the given account-id.

post/mandates/bulk-cancel

Request body

accountIdstring required

The unique identifier for the account for which the mandates are to be cancelled.

migrationType'SCHEDULE_AUDDIS_MIGRATION' | 'TRANSFER_OF_SUN' | 'OFFBOARDING' required

The type of migration process that is being initiated.

auddisCancellationDatestring date

The date for the AUDDIS (Automated Direct Debit Instruction Service) cancellation.

mandateIdsstring[] required

List of mandate ids to be cancelled.

Response

OK

idstring required

Unique id for this bulk request.

accountIdstring required

Unique id for account for this bulk request.

statusstring required

Status for this bulk request.

migrationType'SCHEDULE_AUDDIS_MIGRATION' | 'TRANSFER_OF_SUN' | 'OFFBOARDING' required

Migration type for this bulk request.

totalMandatesRequestedinteger required

Total mandates requested for this bulk request.

auddisCancellationDatestring date required

auddis cancellation date for this bulk request.

Example response

{
  "id": "R210000001",
  "accountId": "A0000001"
}