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 date

Returns all mandates created on or after that date

toDate 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.

hasMore boolean

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

data

object[]

Array of SEPA mandate objects.

Array [

id uuidrequired

Possible values: <= 36 characters

Unique identifier of the mandate.

object stringrequired

Possible values: [MANDATE]

Object type.

createdAt date-timerequired

Mandate creation timestamp.

status stringrequired

Possible values: [CREATED, ACTIVE]

Current status of the mandate.

mandateScheme stringrequired

Possible values: [SEPA_CORE, SEPA_B2B]

Indicates the SEPA mandate scheme.

mandateReference stringrequired

Possible values: <= 70 characters

Unique reference of the mandate.

referenceInstructions

object

nullable

generatedReference booleannullable

True if mandateReference was generated.

mandatePrefix stringnullable

Possible values: <= 50 characters

Prefix used to generate the mandateReference.

debtorName stringnullable

Possible values: <= 140 characters

Name of the debtor.

debtorAddress

object

nullable

addressLine1 stringnullable

Possible values: <= 70 characters

Street name and house number.

number stringnullable

Possible values: <= 10 characters

House number.

postCode stringnullable

Possible values: <= 20 characters

Postal code.

city stringnullable

Possible values: <= 70 characters

City.

countryCode stringnullable

Possible values: <= 2 characters

Country code (ISO 3166-1 alpha-2).

debtorBank

object

nullable

iban stringnullable

Possible values: <= 34 characters

Debtor IBAN.

bankName stringnullable

Possible values: <= 70 characters

Debtor bank name.

bic stringnullable

Possible values: <= 11 characters

Debtor BIC.

creditorName stringrequired

Possible values: <= 140 characters

Creditor name.

creditorIdentifier stringrequired

Possible values: <= 35 characters

SEPA creditor ID.

creditorAddress

object

required

addressLine1 stringnullable

Possible values: <= 70 characters

Street name and house number.

number stringnullable

Possible values: <= 10 characters

House number.

postCode stringnullable

Possible values: <= 20 characters

Postal code.

city stringnullable

Possible values: <= 70 characters

City.

countryCode stringnullable

Possible values: <= 2 characters

Country code (ISO 3166-1 alpha-2).

account

object

nullable

customerAccountId stringnullable

Possible values: <= 255 characters

Customer account identifier.

billingAddress

object

addressLine1 stringrequired

Possible values: <= 60 characters

Street name.

addressLine2 string

Possible values: <= 60 characters

Apartment, suite, unit, building, floor or other secondary address information.

addressLine3 string

Possible values: <= 60 characters

Specific delivery instructions, department names, or additional floor information.

city stringrequired

Possible values: <= 50 characters

The city or localitly of the address.

countryCode stringrequired

Possible values: >= 3 characters and <= 3 characters

ISO-3 code of the address country (e.g., DEU for Germany).

number string

Possible values: <= 10 characters

The house or building number corresponding to the street address.

postCode stringrequired

Possible values: <= 10 characters

The postal or ZIP code of the address.

state string

Possible values: <= 3 characters

3-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.

isBusinessUser booleannullable

Whether the mandate belongs to a business user.

businessConsumer

object

nullable

companyName stringnullable

Possible values: <= 140 characters

Company name.

companyType stringnullable

Possible values: <= 70 characters

Legal form or type of the company.

emailAddress stringnullable

Possible values: <= 254 characters

Contact email.

taxId stringnullable

Possible values: <= 20 characters

Business tax ID.

culture stringnullable

Possible values: <= 10 characters

Regional culture or locale setting.

consumer

object

nullable

firstName stringnullable

Possible values: <= 50 characters

lastName stringnullable

Possible values: <= 50 characters

middleName stringnullable

Possible values: <= 50 characters

emailAddress stringnullable

Possible values: <= 254 characters

dateOfBirth datenullable

gender stringnullable

mobilePhone stringnullable

homePhone stringnullable

workPhone stringnullable

title stringnullable

culture stringnullable

Possible values: <= 10 characters

taxId stringnullable

Possible values: <= 20 characters

activation

object

nullable

mandateSignedLocation stringnullable

Possible values: <= 255 characters

City or place of mandate signature.

mandateDateOfSignature datenullable

Date when mandate was signed.

mandateAcceptance stringnullable

Possible values: [ONLINE, OFFLINE]

Method of mandate acceptance.

additionalData

object[]

nullable

Array [

name stringrequired

Possible values: <= 100 characters

Metadata key.

value stringrequired

Possible values: <= 512 characters

Metadata value.

]

versionTag stringnullable

Possible values: <= 10 characters

Mandate version tag.

versionCreatedAt date-timenullable

Timestamp of mandate version creation.

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

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

Example

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

Loading...