Sign in

v1

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

Bulk request of Direct Debit mandates for the given account-id.

post/mandates/bulk-create

Request body

accountIdstring required

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

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

The type of migration process that is being initiated.

auddisSubmissionDatestring date

The scheduled date for the AUDDIS (Automated Direct Debit Instruction Service) submission. This is the date when the mandates will be submitted to the AUDDIS system for processing.

Example request

{
  "createMandateRequests": [
    {
      "reference": "REFER-1.2",
      "sortCode": "000000",
      "accountNumber": "12345678"
    }
  ]
}

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.

auddisSubmissionDatestring date required

auddis submission date for this bulk request.

Example response

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