2. Flexible mandate: DirectDebit:Add

2.1 API reference

The DirectDebits:add API reference, including the option to execute real-time requests, can be fount at:

https://developer.pay.nl/reference/post_directdebits#/

2.2 Request

{
  "mandate": "IO-####-####-####",
  "isLastOrder": false,
  "description": "gym membership 2025-01-01",
  "processDate": "2025-11-01T12:00:00+02:00",
  "amount": {
    "value": 4999,
    "currency": "EUR"
  },
  "stats": {
    "info": "string",
    "tool": "string",
    "object": "string",
    "extra1": "string",
    "extra2": "string",
    "extra3": "string"
  }
}

2.3 Response

{
  "id": "IL-####-####-####",
  "description": "gym membership 2025-01-01",
  "url": "http:\\/\\/pay.nl",
  "processDate": "2025-11-01T11:26:21+01:00",
  "orderId": "0000000000X00000",
  "paymentSessionId": "0000000000",
  "type": "FLEXIBLE",
  "amount": {
    "value": 4999,
    "currency": "EUR"
  },
  "status": {
    "code": 91,
    "action": "add",
    "phase": "Added"
  },
  "declined": false,
  "decline": {
    "code": 119,
    "name": "Administrative reason",
    "date": "2025-01-01T11:26:21+01:00"
  },
  "bankAccount": {
    "iban": "NL69INGB0123456789",
    "bic": "INGBNL2A",
    "owner": "John Doe"
  },
  "mandate": {
    "code": "IO-####-####-####",
    "description": "gym membership"
  },
  "service": {
    "code": "SL-####-####",
    "name": "Fictional Super Gym New York."
  },
  "merchant": {
    "code": "M-####-####",
    "name": "Fictional Super Gym.",
    "status": "ACTIVE",
    "incorporationCountry": "NL"
  },
  "stats": {
    "info": "string",
    "tool": "string",
    "object": "object1",
    "extra1": "string",
    "extra2": "string",
    "extra3": "string",
    "domainId": null
  },
  "createdAt": "2025-01-01T11:26:21+01:00",
  "createdBy": "AT-####-####",
  "modifiedAt": "2025-01-01T11:26:21+01:00",
  "modifiedBy": "AT-####-####",
  "deletedAt": null,
  "deletedBy": null,
  "_links": [
    {
      "href": "\\/directdebits\\/IL-####-####-####",
      "rel": "details",
      "type": "GET"
    },
    {
      "href": "\\/directdebits",
      "rel": "self",
      "type": "POST"
    }
  ]
}

❗️
Important: a mandate is considered active only after the first DirectDebit has been successfully processed and the funds have been deducted from the customer’s bank account. All subsequent direct debits using this mandate depend on this initial successful transaction.