v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Direct Debits

Create a Direct Debit mandate for the given account-id.

Setting up a Mandate is the first step in creating a Direct Debit. You can only set up scheduled payments ('collections') after there is a Mandate created with the details of the payee.

post/accounts/{accountId}/mandates

Path parameters

accountIdstring required

Id of account to create Direct Debit for.

Request body

namestring required

Name for mandate

referencestring required

Mandate reference, should contain only letters, numbers, space, dot, ampersand, forward-slash , hyphen

externalReferencestring required

External reference for mandate

accountNamestring required

Payee's account name

sortCodestring required

Payee's sort code of account for which direct-debit-mandate has to be created.

accountNumberstring required

Payee's account number for which direct-debit-mandate has to be created.

phonestring required

Payee's phone number

emailstring

Payee's email address

payeeAccountBidstring

Payee's accountBid

Example request

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

Response

idstring required

Unique id for direct-debit-mandate.

accountIdstring required

Unique id for account for this mandate.

referencestring required

DDI reference that was used during creation.

externalReferencestring required

External reference that was used during creation (appears on the bank statement).

createdDatestring date-time required

Datetime when direct-debit-mandate was created.Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000

statusstring required

Status of the direct-debit-mandate. mandates must be 'ACTIVE' to make collections. Can be one of

nextValidCollectionDatestring required

The earliest date a collection can be created. Format is yyyy-MM-dd.

Name given on Mandatestring

sortCodestring required

Sort Code of the account for which direct-debit-mandate has been created.

accountNumberstring required

Account Number for which direct-debit-mandate has been created.

payeeAccountBidstring

Unique id for individual recipient account used for internal transfers

bulkCreateRequestIdstring

Id associate to the bulk create request of this mandate.

bulkCancelRequestIdstring

Id associate to the bulk cancel request of this mandate.

Example response

{
  "id": "G0000001",
  "accountId": "A0000001",
  "createdDate": "2017-01-28T01:01:01+0000",
  "status": "ACTIVE",
  "nextValidCollectionDate": "2018-01-10",
  "sortCode": "123456",
  "accountNumber": "87654321",
  "payeeAccountBid": "A0000001",
  "bulkCreateRequestId": "R210000005",
  "bulkCancelRequestId": "R210000006"
}