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.
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.
This process is expected to be managed directly between the Debtor and Creditor.
Request
Path Parameters
Mandate ID
Header Parameters
Must be application/json
Must be be en-US
The origin of the request
The client making the request
- application/json
- Body
- SEPA B2B - Active
- SEPA B2B - Inactive
- SEPA Core - Active
- SEPA Core - Inctive
Bodyrequired
Name of the debtor (payer) authorizing the SEPA mandate.
Possible values: <= 70 characters
debtorAddress object
Object representing the full billing address of the debtor.
Street name.
Possible values: <= 60 characters
Max-Planck-StraßeApartment, suite, unit, building, floor or other secondary address information.
Possible values: <= 60 characters
Specific delivery instructions, department names, or additional floor information.
Possible values: <= 60 characters
The city or localitly of the address.
Possible values: <= 50 characters
BerlinISO-3 code of the address country (e.g., DEU for Germany).
Possible values: >= 3 characters and <= 3 characters
DEUThe house or building number corresponding to the street address.
Possible values: <= 10 characters
30The postal or ZIP code of the address.
Possible values: <= 10 characters
144733-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.
Possible values: <= 3 characters
debtorBank object
Object representing bank account details of the debtor.
IBAN of the debtor's bank.
Bank name of the debtor.
BIC of the debtor's bank.
Update SEPA B2B ACTIVE mandate
{
"debtorName": "AUTOTRASPORTI FENICE SRL",
"debtorAddress": {
"city": "VIADANA",
"number": "0",
"addressLine1": "VIA VILLA DEL VENEZIANO 13",
"postCode": "46019",
"countryCode": "IT"
},
"debtorBank": {
"iban": "ES912***332",
"bankName": "BNP",
"bic": "CAIXESBBXXX"
}
}
Update SEPA B2B CREATED mandate
{
"debtorName": "AUTOTRASPORTI FENICE SRL",
"debtorAddress": {
"city": "VIADANA",
"number": "0",
"addressLine1": "VIA VILLA DEL VENEZIANO 13",
"postCode": "46019",
"countryCode": "IT"
},
"debtorBank": {
"iban": "ES912***332",
"bankName": "BNP",
"bic": "CAIXESBBXXX"
}
}
Update SEPA CORE ACTIVE mandate
{
"debtorName": "MPS SRL",
"debtorAddress": {
"city": "VIADANA",
"number": "0",
"addressLine1": "VIA VILLA DEL VENEZIANO 13",
"postCode": "46019",
"countryCode": "IT"
},
"debtorBank": {
"iban": "ES912***332",
"bankName": "BNP",
"bic": "CAIXESBBXXX"
}
}
Update SEPA CORE Inactive mandate
{
"debtorName": "AUTOTRASPORTI FENICE SRL",
"debtorAddress": {
"city": "VIADANA",
"number": "0",
"addressLine1": "VIA VILLA DEL VENEZIANO 13",
"postCode": "46019",
"countryCode": "IT"
},
"debtorBank": {
"iban": "ES912***332",
"bankName": "BNP",
"bic": "CAIXESBBXXX"
}
}
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Mandate updated successfully
- application/json
- Schema
- Example (auto)
- SEPA B2B - Active
- SEPA B2B - Inctive
- SEPA Core - Active
- SEPA Core - Inactive
Schema
referenceInstructions objectrequired
Optional object containing configuration for automatic mandate reference generation, such as a prefix.
Possible values: <= 14 characters
debtorAddress object
Details on debtor's address.
Street name.
Possible values: <= 60 characters
Max-Planck-StraßeApartment, suite, unit, building, floor or other secondary address information.
Possible values: <= 60 characters
Specific delivery instructions, department names, or additional floor information.
Possible values: <= 60 characters
The city or localitly of the address.
Possible values: <= 50 characters
BerlinISO-3 code of the address country (e.g., DEU for Germany).
Possible values: >= 3 characters and <= 3 characters
DEUThe house or building number corresponding to the street address.
Possible values: <= 10 characters
30The postal or ZIP code of the address.
Possible values: <= 10 characters
144733-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.
Possible values: <= 70 characters
Possible values: <= 11 characters
Possible values: <= 34 characters
Full name of the debtor authorizing the SEPA mandate.
Possible values: <= 70 characters
Unique identifier of the SEPA mandate.
Possible values: <= 39 characters
System-defined object type (e.g., mandate).
Current status of the SEPA mandate. Example: active, cancelled.
Date and time of mandate creation.
acceptance object
Object referring to the mandate acceptance details.
Timestamp of mandate acceptance creation.
Unique identifier of the acceptance object.
Possible values: <= 39 characters
Type of mandate acceptance provided by the customer.
Date when the mandate was signed by the debtor.
Location where the mandate was signed.
Possible values: <= 14 characters
Technical object name for acceptance.
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.
Street name.
Possible values: <= 60 characters
Max-Planck-StraßeApartment, suite, unit, building, floor or other secondary address information.
Possible values: <= 60 characters
Specific delivery instructions, department names, or additional floor information.
Possible values: <= 60 characters
The city or localitly of the address.
Possible values: <= 50 characters
BerlinISO-3 code of the address country (e.g., DEU for Germany).
Possible values: >= 3 characters and <= 3 characters
DEUThe house or building number corresponding to the street address.
Possible values: <= 10 characters
30The postal or ZIP code of the address.
Possible values: <= 10 characters
144733-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.
Name of the legal entity
Possible values: <= 100 characters
Company registration country ISO2 or ISO3 code
Possible values: >= 2 characters and <= 3 characters
Company registration number
Possible values: <= 50 characters
Possible values: <= 100 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.
Possible values: <= 5 characters
en-ENCustomer email address for any notification
Possible values: <= 255 characters
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.
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
en-ENDate 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}$
1989-11-08Customer email address for any notification
Possible values: <= 255 characters
john.doe@gmail.comPerson first name
Possible values: <= 60 characters
JohnPerson gender
Possible values: <= 6 characters
MrPerson's home phone number (including the country code)
Possible values: <= 30 characters
496912345678Person last name
Possible values: <= 60 characters
DoeConsumer/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
abcd123The customer's middle name
Possible values: <= 60 characters
RobertPerson's mobile phone number (including the country code)
Possible values: <= 30 characters
496912345678Person's tax identification number
Possible values: <= 30 characters
123456789Person title
Possible values: <= 3 characters
MrPerson's work phone number (including the country code)
Possible values: <= 30 characters
496912345678Possible values: <= 125 characters
Possible values: <= 39 characters
Mandate reference identifier assigned by the merchant or the system.
Possible values: <= 35 characters
Type of SEPA mandate scheme.
Possible values: [SEPA_CORE, SEPA_B2B]
Current status of the SEPA mandate.
creditorAddress object
Details on the creditor's address.
Street name.
Possible values: <= 60 characters
Max-Planck-StraßeApartment, suite, unit, building, floor or other secondary address information.
Possible values: <= 60 characters
Specific delivery instructions, department names, or additional floor information.
Possible values: <= 60 characters
The city or localitly of the address.
Possible values: <= 50 characters
BerlinISO-3 code of the address country (e.g., DEU for Germany).
Possible values: >= 3 characters and <= 3 characters
DEUThe house or building number corresponding to the street address.
Possible values: <= 10 characters
30The postal or ZIP code of the address.
Possible values: <= 10 characters
144733-letter code of the address state. Mandatory when countryCode corresponds to Canada or USA.
Possible values: <= 3 characters
Unique SEPA Creditor Identifier used to identify the merchant in SEPA transactions.
Possible values: <= 35 characters
Legal name of the SEPA Creditor initiating the mandate and collecting funds.
Possible values: <= 70 characters
activation objectnullable
City or place of mandate signature.
Possible values: <= 255 characters
Date when mandate was signed.
Method of mandate acceptance.
Possible values: [ONLINE, OFFLINE]
{
"referenceInstructions": {
"mandatePrefix": "string"
},
"debtorAddress": {
"addressLine1": "Max-Planck-Straße",
"addressLine2": "string",
"addressLine3": "string",
"city": "Berlin",
"countryCode": "DEU",
"number": 30,
"postCode": 14473,
"state": "string"
},
"debtorBank": {
"bankName": "string",
"bic": "string",
"iban": "string"
},
"debtorName": "string",
"id": "string",
"object": "string",
"status": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"acceptance": {
"createdAt": "2024-07-29T15:51:28.071Z",
"id": "string",
"mandateAcceptance": "string",
"mandateDateOfSignature": "2024-07-29",
"mandateSignedLocation": "string",
"object": "string",
"storedPaymentOptionReference": "string"
},
"account": {
"billingAddress": {
"addressLine1": "Max-Planck-Straße",
"addressLine2": "string",
"addressLine3": "string",
"city": "Berlin",
"countryCode": "DEU",
"number": 30,
"postCode": 14473,
"state": "string"
},
"businessConsumer": {
"companyName": "string",
"companyRegistrationCountryCode": "string",
"companyRegistrationNumber": "string",
"companyType": "string",
"culture": "en-EN",
"emailAddress": "string",
"taxId": "string"
},
"consumer": {
"culture": "en-EN",
"dateOfBirth": "1989-11-08",
"emailAddress": "john.doe@gmail.com",
"firstName": "John",
"gender": "Mr",
"homePhone": 496912345678,
"lastName": "Doe",
"merchantCustomerId": "abcd123",
"middleName": "Robert",
"mobilePhone": 496912345678,
"taxId": 123456789,
"timezone": "CET",
"title": "Mr",
"workPhone": 496912345678
},
"createdAt": "2024-07-29T15:51:28.071Z",
"customerAccountId": "string",
"id": "string",
"isBusinessUser": true,
"object": "string"
},
"mandateReference": "string",
"mandateScheme": "SEPA_CORE",
"mandateStatus": "string",
"creditorAddress": {
"addressLine1": "Max-Planck-Straße",
"addressLine2": "string",
"addressLine3": "string",
"city": "Berlin",
"countryCode": "DEU",
"number": 30,
"postCode": 14473,
"state": "string"
},
"creditorIdentifier": "string",
"creditorName": "string",
"activation": {
"mandateSignedLocation": "string",
"mandateDateOfSignature": "2024-07-29",
"mandateAcceptance": "ONLINE"
}
}
Update SEPA B2B ACTIVE mandate
{
"id": "d6623427-08ce-4cb8-b39a-03421d2463e8",
"status": "ACTIVE",
"mandateScheme": "SEPA_B2B",
"mandateReference": "CIG0210000000226",
"debtorName": "AUTOTRASPORTI FENICE SRL",
"creditorName": "Iveco S.P.A.",
"creditorIdentifier": "IT123456789",
"account": {
"customerAccountId": "0000219239",
"isBusinessUser": true,
"businessConsumer": {
"emailAddress": "example@example.com",
"companyName": "AUTOTRASPORTI FENICE SRL",
"companyType": "-",
"taxId": "default",
"culture": "en-it"
}
},
"debtorAddress": {
"city": "VIADANA",
"number": "0",
"addressLine1": "VIA VILLA DEL VENEZIANO 13",
"postCode": "46019",
"countryCode": "IT"
},
"creditorAddress": {
"city": "Torino",
"number": "35",
"addressLine1": "Via Puglia",
"postCode": "10156",
"countryCode": "IT"
},
"debtorBank": {
"iban": "ES912***332",
"bankName": "BNP",
"bic": "CAIXESBBXXX"
},
"activation": {
"mandateAcceptance": "ONLINE",
"mandateDateOfSignature": "2024-09-24T00:00:00.000Z",
"storedPaymentOptionReference": "19b3e7e4a8a74de682d4eadccf182360"
},
"additionalData": [
{
"name": "jpmcoid",
"value": "12345"
}
],
"versionTag": "0006",
"createdAt": "2024-09-24T10:07:04.267Z",
"versionCreatedAt": "2024-10-11T15:22:48.932Z",
"referenceInstructions": {
"mandatePrefix": ""
}
}
Update SEPA B2B CREATED (INACTIVE) mandate
{
"id": "d6623427-08ce-4cb8-b39a-03421d2463e8",
"status": "CREATED",
"mandateScheme": "SEPA_B2B",
"mandateReference": "CIG0210000000226",
"debtorName": "AUTOTRASPORTI FENICE SRL",
"creditorName": "Iveco S.P.A.",
"creditorIdentifier": "IT123456789",
"account": {
"customerAccountId": "0000219239",
"isBusinessUser": true,
"businessConsumer": {
"emailAddress": "example@example.com",
"companyName": "AUTOTRASPORTI FENICE SRL",
"companyType": "-",
"taxId": "default",
"culture": "en-it"
}
},
"debtorAddress": {
"city": "VIADANA",
"number": "0",
"addressLine1": "VIA VILLA DEL VENEZIANO 13",
"postCode": "46019",
"countryCode": "IT"
},
"creditorAddress": {
"city": "Torino",
"number": "35",
"addressLine1": "Via Puglia",
"postCode": "10156",
"countryCode": "IT"
},
"debtorBank": {
"iban": "ES912***332",
"bankName": "BNP",
"bic": "CAIXESBBXXX"
},
"additionalData": [
{
"name": "jpmcoid",
"value": "12345"
}
],
"versionTag": "0006",
"createdAt": "2024-09-24T10:07:04.267Z",
"versionCreatedAt": "2024-10-11T15:22:48.932Z",
"referenceInstructions": {
"mandatePrefix": ""
}
}
Update SEPA CORE ACTIVE mandate
{
"id": "d6623427-08ce-4cb8-b39a-03421d2463e8",
"status": "ACTIVE",
"mandateScheme": "SEPA_CORE",
"mandateReference": "CIG0210000000226",
"debtorName": "MPS SRL",
"creditorName": "Creditor S.P.A.",
"creditorIdentifier": "IT123456789",
"account": {
"customerAccountId": "0000219239",
"isBusinessUser": false,
"consumer": {
"emailAddress": "CUST-5AR-00002@abccorp.com",
"dateOfBirth": "2001-12-12",
"firstName": "Pero",
"lastName": "T",
"culture": "en_US",
"middleName": "Str",
"title": "T",
"gender": "male",
"mobilePhone": "012345678",
"homePhone": "012345678",
"workPhone": "012345678",
"taxId": "DE12345678"
}
},
"debtorAddress": {
"city": "VIADANA",
"number": "0",
"addressLine1": "VIA VILLA DEL VENEZIANO 13",
"postCode": "46019",
"countryCode": "IT"
},
"creditorAddress": {
"city": "Torino",
"number": "35",
"addressLine1": "Via Puglia",
"postCode": "10156",
"countryCode": "IT"
},
"debtorBank": {
"iban": "ES912***332",
"bankName": "BNP",
"bic": "CAIXESBBXXX"
},
"activation": {
"mandateAcceptance": "ONLINE",
"mandateDateOfSignature": "2024-09-24T00:00:00.000Z",
"storedPaymentOptionReference": "19b3e7e4a8a74de682d4eadccf182360"
},
"additionalData": [
{
"name": "jpmcoid",
"value": "12345"
}
],
"versionTag": "0006",
"createdAt": "2024-09-24T10:07:04.267Z",
"versionCreatedAt": "2024-10-11T15:22:48.932Z",
"referenceInstructions": {
"mandatePrefix": ""
}
}
SEPA CORE CREATED Updated inactive mandate
{
"id": "d6623427-08ce-4cb8-b39a-03421d2463e8",
"status": "CREATED",
"mandateScheme": "SEPA_CORE",
"mandateReference": "CIG0210000000226",
"debtorName": "AUTOTRASPORTI FENICE SRL",
"creditorName": "Creditor S.P.A.",
"creditorIdentifier": "IT123456789",
"account": {
"customerAccountId": "0000219239",
"isBusinessUser": false,
"consumer": {
"emailAddress": "CUST-5AR-00002@abccorp.com",
"dateOfBirth": "2001-12-12",
"firstName": "Pero",
"lastName": "T",
"culture": "en_US",
"middleName": "Str",
"title": "T",
"gender": "male",
"mobilePhone": "012345678",
"homePhone": "012345678",
"workPhone": "012345678",
"taxId": "DE12345678"
}
},
"debtorAddress": {
"city": "VIADANA",
"number": "0",
"addressLine1": "VIA VILLA DEL VENEZIANO 13",
"postCode": "46019",
"countryCode": "IT"
},
"creditorAddress": {
"city": "Torino",
"number": "35",
"addressLine1": "Via Puglia",
"postCode": "10156",
"countryCode": "IT"
},
"debtorBank": {
"iban": "ES912***332",
"bankName": "BNP",
"bic": "CAIXESBBXXX"
},
"additionalData": [
{
"name": "jpmcoid",
"value": "12345"
}
],
"versionTag": "0006",
"createdAt": "2024-09-24T10:07:04.267Z",
"versionCreatedAt": "2024-10-11T15:22:48.932Z",
"referenceInstructions": {
"mandatePrefix": ""
}
}
Bad Request
For error handling, please refer to this section.
- application/json
- Schema
- Example (auto)
- Example
Schema
- string
- string[]
errorDetails object
message object
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"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
}
}
]
}
Unauthenticated
For error handling, please refer to this section.
- application/json
- Schema
- Example (auto)
- Example
Schema
- string
- string[]
errorDetails object
message object
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "You are not authenticated to perform this request.",
"code": "unauthorized"
}
]
}
Forbidden
For error handling, please refer to this section.
- application/json
- Schema
- Example (auto)
- Example
Schema
- string
- string[]
errorDetails object
message object
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "You do not have permissions to perform this request.",
"code": "forbidden"
}
]
}
Not Found
For error handling, please refer to this section.
- application/json
- Schema
- Example (auto)
- Example
Schema
- string
- string[]
errorDetails object
message object
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Resource not found.",
"code": "not_found"
}
]
}
Internal Server Error
For error handling, please refer to this section.
- application/json
- Schema
- Example (auto)
- Example
Schema
- string
- string[]
errorDetails object
message object
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Internal server error."
}
]
}