Docs

REST API

Beneficiaries

POST/api/beneficiaries

Register who can be paid.

Request

JSON
{
  "fullName": "Acme Supplies BV",
  "iban": "DE89370400440532013000",
  "reference": "acme",
  "email": "[email protected]"
}

Response 200

JSON
{
  "ok": true,
  "data": {
    "beneficiaryId": "9596acc9-0320-4b89-8cc8-475f04fe3948",
    "fullName": "Acme Supplies BV",
    "iban": "DE89370400440532013000",
    "reference": "acme",
    "email": "[email protected]",
    "createdAt": "2026-09-23T18:42:40.619Z"
  }
}

POST/api/validate-iban

Check an IBAN's format and checksum.

Request

JSON
{
  "iban": "DE89 3704 0044 0532 0130 00"
}

Response 200

JSON
{
  "ok": true,
  "data": {
    "originalIban": "DE89 3704 0044 0532 0130 00",
    "normalizedIban": "DE89370400440532013000",
    "isValid": true,
    "countryCode": "DE",
    "formatValid": true,
    "checksumValid": true,
    "explanation": "IBAN is valid."
  }
}