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.

    cursor string

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

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

    Possible values: >= 1 and <= 100

    Default value: 25

    For pagination, total number of results to return

Responses​

Successful response

Schema

    data

    object[]

    Collection of mandates created for this integrator.

  • Array [

    • referenceInstructions

    object

    required

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

    mandatePrefix string

    Possible values: <= 14 characters

    debtorAddress

    object

    Details on debtor's address.

    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

    Details on debtor's bank.

    bankName string

    Possible values: <= 70 characters

    bic string

    Possible values: <= 11 characters

    iban string

    Possible values: <= 34 characters

    debtorName string

    Possible values: <= 70 characters

    Full name of the debtor authorizing the SEPA mandate.

    id string

    Possible values: <= 39 characters

    Unique identifier of the SEPA mandate.

    object string

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

    status string

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

    createdAt date-time

    Date and time of mandate creation.

    acceptance

    object

    Object referring to the mandate acceptance details.

    createdAt date-time

    Timestamp of mandate acceptance creation.

    id string

    Possible values: <= 39 characters

    Unique identifier of the acceptance object.

    mandateAcceptance stringrequired

    Type of mandate acceptance provided by the customer.

    mandateDateOfSignature daterequired

    Date when the mandate was signed by the debtor.

    mandateSignedLocation string

    Possible values: <= 14 characters

    Location where the mandate was signed.

    object string

    Technical object name for acceptance.

    storedPaymentOptionReference string

    Possible values: <= 70 characters

    Reference to the stored payment option for this mandate.

    account

    object

    Object of the account.

    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
    mandateReference string

    Possible values: <= 35 characters

    Mandate reference identifier assigned by the merchant or the system.

    mandateScheme stringrequired

    Possible values: [SEPA_CORE, SEPA_B2B]

    Type of SEPA mandate scheme.

    mandateStatus string

    Current status of the SEPA mandate.

    creditorAddress

    object

    Details on the creditor's address.

    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.

    creditorIdentifier string

    Possible values: <= 35 characters

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

    creditorName string

    Possible values: <= 70 characters

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

    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.

  • ]

    • meta

    object

    hasMore boolean

    True if there are more items, then returned.

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