Skip to main content

Create SEPA Mandate

POST 
/mandates

The endpoint supports creating mandates in two ways:

  1. Use a system generated mandate reference with optional pre-fix by submission of referenceInstructions.
  2. Use an own mandate reference by submitting mandateReference attribute in create mandate request.

The following section will describe the procedure and results of creating a new mandate.

The mandate reference must be unique in the scope of a creditor reference, duplicate mandate references cannot be activated.

info

Each mandate requires data of the creditor for the mandate. Your Product Solution Specialist can help you to assess the correct setup for the creditor data. Mandate management solution supports both — the use of merchant specific creditor identification, passed via create mandate API or use of pre-configured creditor identification data, which would be returned in create mandate response.

The current release of mandate management solution supports SEPA mandates:
mandateScheme = "SEPA_B2B" or "SEPA_CORE"

Request​

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

Body

required

    mandateScheme stringrequired

    Possible values: [SEPA_B2B, SEPA_CORE]

    Specifies the SEPA scheme type to use for the mandate.

    mandateReference string

    Possible values: <= 35 characters

    Unique identifier for the mandate reference assigned by the creditor.

    referenceInstructions

    object

    nullable

    required

    Optional object containing creditor-provided instructions for mandate Reference.

    mandatePrefix string

    Possible values: <= 10 characters

    Prefix string to be prepended to the generated mandate reference identifier.

    debtorName string

    Possible values: <= 70 characters

    Name of the debtor (payer) authorizing the SEPA mandate.

    debtorAddress

    object

    Object representing the full billing address of the debtor.

    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.

    debtorBank

    object

    Object representing bank account details of the debtor.

    iban string

    IBAN of the debtor's bank.

    bankName string

    Bank name of the debtor.

    bic string

    BIC of the debtor's bank.

    creditorName string

    Possible values: <= 70 characters

    Legal name of the creditor collecting the SEPA payments.

    creditorIdentifier string

    Possible values: <= 35 characters

    SEPA Creditor Identifier assigned by the national authority to the merchants.

    creditorAddress

    object

    Object representing the full address details of the creditor.

    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.

    account

    object

    Object containing internal or external account references used by the system.

    billingAddress

    object

    Consumer's billing address data. See Address in Data model.

    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.

    businessConsumer

    object

    Company data, in case the consumer is a business or a legal entity.
    Mandatory, unless consumer is provided.
    consumer and businessConsumer objects may not be submitted together.

    companyName stringrequired

    Possible values: <= 100 characters

    Name of the legal entity

    companyRegistrationCountryCode string

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

    Company registration country ISO2 or ISO3 code

    companyRegistrationNumber string

    Possible values: <= 50 characters

    Company registration number

    companyType stringrequired

    Possible values: <= 100 characters

    culture string

    Possible values: <= 5 characters

    Consists of ISO 639-1 language code and ISO 3166-1 alpha-2 country code separated by dash. If this value is not provided the browser culture is used. Default culture is English (e.g., en-de). This field is not case sensitive.

    emailAddress stringrequired

    Possible values: <= 255 characters

    Customer email address for any notification

    taxId string

    Possible values: <= 30 characters

    Person's tax identification number

    consumer

    object

    Consumer's personal data, in case the consumer is a physical person.
    Mandatory, unless businessConsumer is provided.
    consumer and businessConsumer objects may not be submitted together.

    culture string

    Possible values: <= 5 characters

    Consists of ISO 639-1 language code and ISO 3166-1 alpha-2 country code separated by dash. If this value is not provided the browser culture is used. Default culture is English (e.g., en-de). This field is not case sensitive.

    dateOfBirth date

    Possible values: <= 10 characters, Value must match regular expression ^\d{4}-\d{2}-\d{2}$

    Date of birth. Format - YYYY-MM-DD. Mandatory for payment option registration flow. Minimum date allowed is 1900-01-01

    emailAddress emailrequired

    Possible values: <= 255 characters

    Customer email address for any notification

    firstName stringrequired

    Possible values: <= 60 characters

    Person first name

    gender string

    Possible values: <= 6 characters

    Person gender

    homePhone string

    Possible values: <= 30 characters

    Person's home phone number (including the country code)

    lastName stringrequired

    Possible values: <= 60 characters

    Person last name

    merchantCustomerId string

    Possible values: <= 255 characters

    Consumer/Customer Account Id in the merchant system. When provided into the Create Checkout API, SmartPay will request e-wallet account creation which will have external account reference equals to the given merchantCustomerId value.

    middleName string

    Possible values: <= 60 characters

    The customer's middle name

    mobilePhone string

    Possible values: <= 30 characters

    Person's mobile phone number (including the country code)

    taxId string

    Possible values: <= 30 characters

    Person's tax identification number

    timezone string

    Possible values: <= 50 characters

    Preferred timezone name

    title string

    Possible values: <= 3 characters

    Person title

    workPhone string

    Possible values: <= 30 characters

    Person's work phone number (including the country code)

    createdAt date-time
    customerAccountId string

    Possible values: <= 125 characters

    id string

    Possible values: <= 39 characters

    isBusinessUser boolean
    object string

    additionalData

    object

    Optional object for sending integration-specific or metadata-related fields.

    name string

    Possible values: <= 100 characters

    value string

    Possible values: <= 255 characters

Responses​

Mandate created successfully

Schema

    id uuidrequired

    Possible values: <= 36 characters

    Unique identifier of the mandate

    object stringrequired

    Possible values: [MANDATE]

    Object type identifier

    createdAt date-timerequired

    Timestamp of mandate creation in ISO 8601 format

    status stringrequired

    Possible values: [CREATED]

    Mandate status

    mandateScheme stringrequired

    Possible values: [SEPA_CORE, SEPA_B2B]

    SEPA mandate scheme type

    mandateReference stringrequired

    Possible values: <= 70 characters

    Mandate reference (shop-defined or system-generated)

    referenceInstructions

    object

    nullable

    Instructions for generating a mandate reference prefix

    mandatePrefix stringnullable

    Possible values: <= 50 characters

    Prefix used for generating mandate references

    debtorName stringnullable

    Possible values: <= 140 characters

    Full 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

    IBAN of the debtor

    bankName stringnullable

    Possible values: <= 70 characters

    Name of the debtor's bank

    bic stringnullable

    Possible values: <= 11 characters

    BIC of the debtor's bank

    creditorName stringrequired

    Possible values: <= 140 characters

    Name of the creditor

    creditorIdentifier stringrequired

    Possible values: <= 35 characters

    Creditor SEPA identifier

    creditorAddress

    object

    required

    addressLine1 string

    Possible values: <= 70 characters

    Street name and house number

    number string

    Possible values: <= 10 characters

    House number

    postCode string

    Possible values: <= 20 characters

    Postal code

    city string

    Possible values: <= 70 characters

    City

    countryCode string

    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

    Flag indicating business user

    businessConsumer

    object

    nullable

    companyName stringnullable

    Possible values: <= 140 characters

    Company name of business user

    companyType stringnullable

    Possible values: <= 70 characters

    Type of business entity

    emailAddress stringnullable

    Possible values: <= 254 characters

    Contact email

    taxId stringnullable

    Possible values: <= 20 characters

    Tax identifier

    culture stringnullable

    Possible values: <= 10 characters

    Locale/culture info

    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

    additionalData

    object[]

    nullable

  • Array [

    • name string

    Metadata key

    value string

    Metadata value

  • ]

    • versionTag stringnullable

    Possible values: <= 10 characters

    Mandate version tag

    versionCreatedAt date-timenullable

    Timestamp of this version creation

Loading...
 Imprint
|
Data protection and privacy
© 2025 J.P. Morgan Mobility Payments Systems GmbH. All rights reserved.