Get All SEPA Mandates

GET 
/mandates

Retrieve all mandates for the integrator making the request (identified by basicAuth).

Request

Query Parameters

status string

Possible values: [CREATED, ACTIVE, CLOSED]

Filter mandates by status

fromDate string<date>

Returns all mandates created on or after that date

toDate string<date>

Returns all mandates created on or before that date

cursor string

First mandate after MandateId provided will be returned

pageSize integer

Used for pagination, total number of results to return

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

Responses

200

Successful response

application/json

Schema

Schema

meta object

Reponse-level metadata object. Used for pagination and extended control in list-based or batched response.

hasMoreboolean

Indicates whether more mandate records are avilable beyond the current response payload. Used for pagination purposes.

data object[]
Array of SEPA mandate objects.
Array [
idstring<uuid>required
Unique identifier of the mandate.
Possible values: <= 36 characters
objectstringrequired
Object type.
Possible values: [MANDATE]
createdAtstring<date-time>required
Mandate creation timestamp.
statusstringrequired
Current status of the mandate.
Possible values: [CREATED, ACTIVE]
mandateSchemestringrequired
Indicates the SEPA mandate scheme.
Possible values: [SEPA_CORE, SEPA_B2B]
mandateReferencestringrequired
Unique reference of the mandate.
Possible values: <= 70 characters
referenceInstructions objectnullable
generatedReferencebooleannullable
True if mandateReference was generated.
mandatePrefixstringnullable
Prefix used to generate the mandateReference.
Possible values: <= 50 characters
debtorNamestringnullable
Name of the debtor.
Possible values: <= 140 characters
debtorAddress objectnullable
addressLine1stringnullable
Street name and house number.
Possible values: <= 70 characters
numberstringnullable
House number.
Possible values: <= 10 characters
postCodestringnullable
Postal code.
Possible values: <= 20 characters
citystringnullable
City.
Possible values: <= 70 characters
countryCodestringnullable
Country code (ISO 3166-1 alpha-2).
Possible values: <= 2 characters
debtorBank objectnullable
ibanstringnullable
Debtor IBAN.
Possible values: <= 34 characters
bankNamestringnullable
Debtor bank name.
Possible values: <= 70 characters
bicstringnullable
Debtor BIC.
Possible values: <= 11 characters
creditorNamestringrequired
Creditor name.
Possible values: <= 140 characters
creditorIdentifierstringrequired
SEPA creditor ID.
Possible values: <= 35 characters
creditorAddress objectrequired
addressLine1stringnullable
Street name and house number.
Possible values: <= 70 characters
numberstringnullable
House number.
Possible values: <= 10 characters
postCodestringnullable
Postal code.
Possible values: <= 20 characters
citystringnullable
City.
Possible values: <= 70 characters
countryCodestringnullable
Country code (ISO 3166-1 alpha-2).
Possible values: <= 2 characters
account objectnullable
customerAccountIdstringnullable
Customer account identifier.
Possible values: <= 255 characters
billingAddress object
addressLine1stringrequired
Street name.
Possible values: <= 60 characters
Example: Max-Planck-Straße
addressLine2string
Apartment, suite, unit, building, floor or other secondary address information.
Possible values: <= 60 characters
addressLine3string
Specific delivery instructions, department names, or additional floor information.
Possible values: <= 60 characters
citystringrequired
The city or localitly of the address.
Possible values: <= 50 characters
Example: Berlin
countryCodestringrequired
ISO-3 code of the address country (e.g., DEU for Germany).
Possible values: >= 3 characters and <= 3 characters
Example: DEU
numberstring
The house or building number corresponding to the street address.
Possible values: <= 10 characters
Example: 30
postCodestringrequired
The postal or ZIP code of the address.
Possible values: <= 10 characters
Example: 14473
statestring
3-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.
Possible values: <= 3 characters
isBusinessUserbooleannullable
Whether the mandate belongs to a business user.
businessConsumer objectnullable
companyNamestringnullable
Company name.
Possible values: <= 140 characters
companyTypestringnullable
Legal form or type of the company.
Possible values: <= 70 characters
emailAddressstringnullable
Contact email.
Possible values: <= 254 characters
taxIdstringnullable
Business tax ID.
Possible values: <= 20 characters
culturestringnullable
Regional culture or locale setting.
Possible values: <= 10 characters
consumer objectnullable
firstNamestringnullable
Possible values: <= 50 characters
lastNamestringnullable
Possible values: <= 50 characters
middleNamestringnullable
Possible values: <= 50 characters
emailAddressstringnullable
Possible values: <= 254 characters
dateOfBirthstring<date>nullable
genderstringnullable
mobilePhonestringnullable
homePhonestringnullable
workPhonestringnullable
titlestringnullable
culturestringnullable
Possible values: <= 10 characters
taxIdstringnullable
Possible values: <= 20 characters
activation objectnullable
mandateSignedLocationstringnullable
City or place of mandate signature.
Possible values: <= 255 characters
mandateDateOfSignaturestring<date>nullable
Date when mandate was signed.
mandateAcceptancestringnullable
Method of mandate acceptance.
Possible values: [ONLINE, OFFLINE]
additionalData object[]nullable
Array [
namestringrequired
Metadata key.
Possible values: <= 100 characters
valuestringrequired
Metadata value.
Possible values: <= 512 characters
]
versionTagstringnullable
Mandate version tag.
Possible values: <= 10 characters
versionCreatedAtstring<date-time>nullable
Timestamp of mandate version creation.
]

Example (auto)

{
  "meta": {
    "hasMore": true
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "object": "MANDATE",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "status": "CREATED",
      "mandateScheme": "SEPA_CORE",
      "mandateReference": "string",
      "referenceInstructions": {
        "generatedReference": true,
        "mandatePrefix": "string"
      },
      "debtorName": "string",
      "debtorAddress": {
        "addressLine1": "string",
        "number": "string",
        "postCode": "string",
        "city": "string",
        "countryCode": "string"
      },
      "debtorBank": {
        "iban": "string",
        "bankName": "string",
        "bic": "string"
      },
      "creditorName": "string",
      "creditorIdentifier": "string",
      "creditorAddress": {
        "addressLine1": "string",
        "number": "string",
        "postCode": "string",
        "city": "string",
        "countryCode": "string"
      },
      "account": {
        "customerAccountId": "string",
        "billingAddress": {
          "addressLine1": "Max-Planck-Straße",
          "addressLine2": "string",
          "addressLine3": "string",
          "city": "Berlin",
          "countryCode": "DEU",
          "number": 30,
          "postCode": 14473,
          "state": "string"
        },
        "isBusinessUser": true,
        "businessConsumer": {
          "companyName": "string",
          "companyType": "string",
          "emailAddress": "string",
          "taxId": "string",
          "culture": "string"
        },
        "consumer": {
          "firstName": "string",
          "lastName": "string",
          "middleName": "string",
          "emailAddress": "string",
          "dateOfBirth": "2024-07-29",
          "gender": "string",
          "mobilePhone": "string",
          "homePhone": "string",
          "workPhone": "string",
          "title": "string",
          "culture": "string",
          "taxId": "string"
        }
      },
      "activation": {
        "mandateSignedLocation": "string",
        "mandateDateOfSignature": "2024-07-29",
        "mandateAcceptance": "ONLINE"
      },
      "additionalData": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "versionTag": "string",
      "versionCreatedAt": "2024-07-29T15:51:28.071Z"
    }
  ]
}

SEPA B2B

Paginated response for SEPA B2B mandates

{
  "meta": {
    "hasMore": false
  },
  "data": [
    {
      "id": "md_54c8e62b-f96a-4698-8323-783284873a68",
      "object": "MANDATE",
      "createdAt": "2023-03-02T14:25:59.078Z",
      "mandateScheme": "SEPA_B2B",
      "mandateReference": "SEPA-20230906-ABC123",
      "status": "CREATED",
      "creditorName": "ABC Corporation",
      "creditorIdentifier": "DE123456789",
      "creditorAddress": {
        "city": "Munich",
        "countryCode": "DE",
        "number": "456",
        "addressLine1": "Leopoldstr.",
        "postCode": "80807"
      }
    }
  ]
}

SEPA CORE

Paginated response for SEPA CORE mandates

{
  "meta": {
    "hasMore": false
  },
  "data": [
    {
      "id": "md_317bbac6-30c2-4147-9d75-0d888e502fdc",
      "object": "MANDATE",
      "createdAt": "2024-12-10T15:45:41.067Z",
      "status": "CREATED",
      "mandateScheme": "SEPA_CORE",
      "mandateReference": "SEPAmandate",
      "debtorName": "Test Debtor",
      "debtorAddress": {
        "number": "13",
        "addressLine1": "VIA DI SPINI",
        "postCode": "36121",
        "city": "Trento",
        "countryCode": "IT"
      },
      "creditorName": "MPS MUC",
      "creditorIdentifier": "DE123456789",
      "creditorAddress": {
        "number": "",
        "addressLine1": "Leopoldstr.",
        "postCode": "80807",
        "city": "München",
        "countryCode": "DE"
      },
      "versionTag": "0001",
      "versionCreatedAt": "2024-12-10T15:45:41.067Z",
      "additionalData": [
        {
          "name": "jpmcoid",
          "value": "abcdefg"
        }
      ],
      "account": {
        "customerAccountId": "Test_01",
        "billingAddress": {
          "number": "15",
          "addressLine1": "Samplestr.",
          "postCode": "12345",
          "city": "Sampletown",
          "countryCode": "DE"
        },
        "isBusinessUser": false,
        "consumer": {
          "firstName": "John",
          "lastName": "Doe",
          "emailAddress": "NewcustomerSEPA@mail.com",
          "gender": "male",
          "mobilePhone": "0159905737",
          "culture": "DE-DE",
          "taxId": "DE987654321",
          "homePhone": "03842418569",
          "middleName": "Joe",
          "dateOfBirth": "1995-01-26",
          "workPhone": "03842418569"
        }
      },
      "debtorBank": {
        "bic": "PSSTFRPPLIL",
        "bankName": "Banca Sample",
        "iban": "FR1420041010050500013M02606"
      }
    }
  ]
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Value out of bounds. Value must be between 1 and 100",
      "code": "value_out_of_bounds",
      "property": "someField",
      "context": {
        "minimum": 1,
        "maximum": 100
      }
    }
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}