Skip to main content

Update SEPA Mandate

PUT 
/mandates/:mandateId

Update or complete a mandate by setting the specified parameter values. Any unprovided parameters will remain unchanged.
Update mandate management allows the update of both mandate before and after activation.

important

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

Update active mandate​

For an update to a mandate in active status, either the Creditor or Debtor may amend this mandate at any time. The amendments that are of concern to both the Creditor Payment Service Provider (PSP) and Debtor PSP include the following scenarios:

  • The Creditor needs to change the unique Mandate Reference due to internal organizational changes, such as restructuring.
  • The Creditor Identifier has changed as a result of a merger, acquisition, spin-off, or other organizational changes.
  • The Creditor has changed its name.
  • The Debtor chooses to use a different account within the same PSP or with another PSP.
  • The Debtor's bank undergoes changes such as rebranding, mergers, or other structural adjustments, and updating the BIC may be necessary.

Both the Creditor and Debtor are responsible and liable for updating the mandate characteristics they manage, should any of these characteristics change during the mandate's lifecycle.

When the identity of the Creditor changes due to a merger or acquisition, the new Creditor must inform the Debtor of the related mandate amendments (e.g., via letter or email) to avoid disputes over collections if the Debtor does not recognize the Creditor's name or identifier on their account statement.

The Debtor is required to notify the Debtor PSP of any mandate amendments agreed upon with the Creditor if they involve changes to one or more of the following attributes:

  • New Mandate Reference
  • New Creditor Identifier
  • New Creditor Name
  • New Debtor account to be debited, whether with the same PSP or another PSP
  • New Debtor bank BIC

The Debtor PSP must at a minimum verify the consistency between the mandate data provided with collections and the mandate data stored in its system. If instructed by the Debtor PSP, the Debtor must inform the PSP of any accepted mandate amendments.

info

This process is expected to be managed directly between the Debtor and Creditor.

Request​

Path Parameters

    mandateId stringrequired

    Mandate ID

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

    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.

Responses​

Mandate updated successfully

Schema

    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.

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