Skip to main content

Get SEPA Mandate History

GET 
/mandates/:mandateId/history

This endpoint returns all mandates in scope of the calling integrator.

important

When a mandate is updated via Update Mandate API, a new version is automatically generated to reflect the latest changes. All historical versions are retained for reference, and can be retrieved through this endpoint to ensure traceability and audit consistency.

Request​

Path Parameters

    mandateId stringrequired

Query Parameters

    versionTag VersionTag

    Possible values: <= 4 characters, Value must match regular expression ^[0-9]{4}, >= 4

    Returns specific version of Mandate.

    Example: 0001
    cursor string

    First mandate after MandateId provided will be returned. Used for pagination.

    Example: md_7c1c304e-72bf-2b57-2570-148879f6da20
    pageSize integer<int32>

    Possible values: >= 1 and <= 100

    For pagination, total number of results to return

    Default value: 25

Responses​

Successful response

Schema
    data object[]

    Collection of mandates created for this integrator.

  • Array [
    • referenceInstructions objectrequired

    Optional object containing configuration for automatic mandate reference generation, such as a prefix.

    mandatePrefixstring

    Possible values: <= 14 characters

    debtorAddress object

    Details on debtor's address.

    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

    debtorBank object

    Details on debtor's bank.

    bankNamestring

    Possible values: <= 70 characters

    bicstring

    Possible values: <= 11 characters

    ibanstring

    Possible values: <= 34 characters

    debtorNamestring

    Full name of the debtor authorizing the SEPA mandate.

    Possible values: <= 70 characters

    idstring

    Unique identifier of the SEPA mandate.

    Possible values: <= 39 characters

    objectstring

    System-defined object type (e.g., mandate).

    statusstring

    Current status of the SEPA mandate. Example: active, cancelled.

    createdAtstring<date-time>

    Date and time of mandate creation.

    acceptance object

    Object referring to the mandate acceptance details.

    createdAtstring<date-time>

    Timestamp of mandate acceptance creation.

    idstring

    Unique identifier of the acceptance object.

    Possible values: <= 39 characters

    mandateAcceptancestringrequired

    Type of mandate acceptance provided by the customer.

    mandateDateOfSignaturestring<date>required

    Date when the mandate was signed by the debtor.

    mandateSignedLocationstring

    Location where the mandate was signed.

    Possible values: <= 14 characters

    objectstring

    Technical object name for acceptance.

    storedPaymentOptionReferencestring

    Reference to the stored payment option for this mandate.

    Possible values: <= 70 characters

    account object

    Object of the account.

    billingAddress object

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

    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

    businessConsumer objectnullable

    Company data, in case the consumer is a business or a legal entity. See businessConsumer in Data model.
    Conditional. Can be present if consumer is missing from the request.

    companyNamestringrequired

    Name of the legal entity

    Possible values: <= 100 characters

    companyRegistrationCountryCodestring

    Company registration country ISO2 or ISO3 code

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

    companyRegistrationNumberstring

    Company registration number

    Possible values: <= 50 characters

    companyTypestringrequired

    Possible values: <= 100 characters

    culturestring

    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.

    Possible values: <= 5 characters

    Example: en-EN
    emailAddressstringrequired

    Customer email address for any notification

    Possible values: <= 255 characters

    taxIdstring

    Person's tax identification number

    Possible values: <= 30 characters

    consumer objectnullable

    Consumer's personal data, in case the consumer is a physical person. See consumer in Data model.
    Conditional. Can be present if businessConsumer is missing from the request.

    culturestring

    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.

    Possible values: <= 5 characters

    Example: en-EN
    dateOfBirthstring<date>

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

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

    Example: 1989-11-08
    emailAddressstring<email>required

    Customer email address for any notification

    Possible values: <= 255 characters

    Example: john.doe@gmail.com
    firstNamestringrequired

    Person first name

    Possible values: <= 60 characters

    Example: John
    genderstring

    Person gender

    Possible values: <= 6 characters

    Example: Mr
    homePhonestring

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

    Possible values: <= 30 characters

    Example: 496912345678
    lastNamestringrequired

    Person last name

    Possible values: <= 60 characters

    Example: Doe
    merchantCustomerIdstring

    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.

    Possible values: <= 255 characters

    Example: abcd123
    middleNamestring

    The customer's middle name

    Possible values: <= 60 characters

    Example: Robert
    mobilePhonestring

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

    Possible values: <= 30 characters

    Example: 496912345678
    taxIdstring

    Person's tax identification number

    Possible values: <= 30 characters

    Example: 123456789
    timezonestring

    Preferred timezone name

    Possible values: <= 50 characters

    Example: CET
    titlestring

    Person title

    Possible values: <= 3 characters

    Example: Mr
    workPhonestring

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

    Possible values: <= 30 characters

    Example: 496912345678
    createdAtstring<date-time>
    customerAccountIdstring

    Possible values: <= 125 characters

    idstring

    Possible values: <= 39 characters

    isBusinessUserboolean
    objectstring
    mandateReferencestring

    Mandate reference identifier assigned by the merchant or the system.

    Possible values: <= 35 characters

    mandateSchemestringrequired

    Type of SEPA mandate scheme.

    Possible values: [SEPA_CORE, SEPA_B2B]

    mandateStatusstring

    Current status of the SEPA mandate.

    creditorAddress object

    Details on the creditor's address.

    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

    creditorIdentifierstring

    Unique SEPA Creditor Identifier used to identify the merchant in SEPA transactions.

    Possible values: <= 35 characters

    creditorNamestring

    Legal name of the SEPA Creditor initiating the mandate and collecting funds.

    Possible values: <= 70 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]

  • ]
    • meta object
    hasMoreboolean

    True if there are more items, then returned.

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