SEPA mandate management

A SEPA mandate is a legally binding contract permitting a company to withdraw funds from a customer's bank account. With Mandate Management service, it is possible to create, modify, retrieve, and manage mandates efficiently, including empty, partially filled and fully filled mandates.

A SEPA mandate consists of:

Creditor segment - data and identification of the payee:
- Name and address of the creditor
- Creditor Identifier Number = financial authority issued identification of Creditor in SEPA schema
Mandate information:
- Mandate Reference = unique reference of this SEPA mandate. It needs to be unique in the scope of a creditor reference
- Mandate type = recurring or one-off
- Mandate legal information
Debtor segment - data and identification of the payer:
- Name and address of the debtor
- Bank Account Number used for the direct debit
- SWIFT BIC - Bank Identification

This SEPA mandate management solution is intended to be used to support the processing of SEPA direct debit payments, but not for management of the actual mandate documents.

It is the client's obligation to:

Collect all data relevant for the mandate
Create a mandate document and ensure that it is signed by the debtor / payer
In case of B2B mandates to ensure that payer has submitted to the payer's bank prior first payment authorization
Submit all required fields as on the original mandate document
Archive the "paper" mandate

Note to creditor identification number:

A creditor identification number is assigned to a debtor by the respective member state's financial authority. The mandate management solution can be used with an own creditor identifier or using J.P. Morgan Mobility Payments S.A.'s general creditor identifier. Your product solution specialist can support you with the right setup for your use case.

info

SEPA mandate management is an alternative service to the widget based SEPA core processing, designed for merchants who create and manage SEPA mandates in their own workflows. Parallel use of mandates in mandate management solution and processing of SEPA core mandates created via SmartPay / Subscription web forms is not supported. Please contact your product solutions specialist or key account manager for further information.

Base URLs & additional details

	SANDBOX	PRODUCTION
API Base URL	`https://mandatemgmt.cons.shared.upcf.jpmmps.com/api/v1/mandates`	`https://mandatemgmt.shared.upcf.jpmmps.com/api/v1/mandates`
Merchant Key	Provided by Product Solutions Specialist	Provided by Key Account Manager
API Authentication Key	Provided by Product Solutions Specialist	Provided by Key Account Manager

Further details of data model used in mandate management: Data Model

Create SEPA mandate

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

The endpoint supports creating mandates in two ways:

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

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

Creditor Identification Data

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.

Supported Mandate Schemes

Current release of mandate management solution supports SEPA B2B mandates
mandateScheme = "SEPA_B2B".

Create new empty mandate

Create new empty mandate request

Paths:

POST {baseURL}/mandates

Header: Content-Type: application/json
        Accept-Language: en_US

// Request mandate with own mandate reference
{
  "mandateScheme": "SEPA_B2B",
  "mandateReference": "SEPA-B2B-UM34GFJTYUXNQVGP7SB7"
}

// Request mandate with generated mandate reference
{
  "mandateScheme": "SEPA_B2B",
  "referenceInstructions": {
    "mandatePrefix": "SEPA-20230906"
  }
}

// Request mandate with generated mandate reference without prefix and own creditor information
{
  "mandateScheme": "SEPA_B2B",
  "referenceInstructions": {
    "mandatePrefix": ""
  },
  "creditorName": "ABC Corporation",
  "creditorIdentifier": "DE123456789",
  "creditorAddress": {
    "city": "Munich",
    "countryCode": "DE",
    "number": "456",
    "addressLine1": "Leopoldstr.",
    "postCode": "80807"
  }
}

Create new empty mandate response

Status Code:

201 (OK)

Header:

Accept-Language: en_US

{
  "id": "md_ba22fd34-894c-4232-993a-c56a3e960e47",
  "object": "MANDATE",
  "createdAt": "2023-03-02T14:25:59.078Z",
  "mandateScheme": "SEPA_B2B",
  "mandateReference": "SEPA-20230906-ABC123",
  "status": "CREATED",
  "creditorName": "ABC Corporation",
  "creditorIdentifier": "DE98ZZZ09999999999",
  "creditorAddress": {
    "city": "Munich",
    "countryCode": "DE",
    "number": "456",
    "addressLine1": "Leopoldstr.",
    "postCode": "80807"
  }
}

Create new partially filled mandate

This section describes how to create a new mandate filled with debtor data only.

Create a new partially filled mandate request

Path:

POST {baseURL}/mandates

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "mandateScheme": "SEPA_B2B",
  "mandateReference": "SEPA-20230906-ABC123",
  "debtorName": "John Doe",
  "debtorAddress": {
    "city": "Berlin",
    "countryCode": "DE",
    "number": "123",
    "addressLine1": "Main Street",
    "postCode": "12345"
  },
  "debtorBank": {
    "iban": "DE89370400440532013000",
    "bankName": "Example Bank",
    "bic": "EXBKDE81XXX"
  }
}

Create new partially filled mandate response

Status Code:

201 (OK)

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "id": "md_7c1c304e-72bf-2b57-2570-148879f6da20",
  "object": "MANDATE",
  "createdAt": "2023-03-02T14:25:59.078Z",
  "mandateScheme": "SEPA_B2B",
  "mandateReference": "SEPA-20230906-ABC123",
  "status": "CREATED",
  "debtorName": "John Doe",
  "debtorAddress": {
    "city": "Berlin",
    "countryCode": "DE",
    "number": "123",
    "addressLine1": "Main Street",
    "postCode": "12345"
  },
  "debtorBank": {
    "iban": "DE89370400440532013000",
    "bankName": "Example Bank",
    "bic": "EXBKDE81XXX"
  },
  "creditorName": "ABC Corporation",
  "creditorIdentifier": "DE98ZZZ09999999999",
  "creditorAddress": {
    "city": "Munich",
    "countryCode": "DE",
    "number": "456",
    "addressLine1": "Leopoldstr.",
    "postCode": "80807"
  }
}

Create new fully filled mandate

This section describes how to create a new fully filled mandate. This mandate has to have a client issued mandateReference that needs to be unique for each client making the request.

Create new fully filled mandate request

Path:

POST {baseURL}/mandates

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "mandateScheme": "SEPA_B2B",
  "referenceInstructions": {
    "mandatePrefix": "SEPA-20230906"
  },
  "debtorName": "John Doe",
  "debtorAddress": {
    "city": "Berlin",
    "countryCode": "DE",
    "number": "123",
    "addressLine1": "Main Street",
    "postCode": "12345"
  },
  "debtorBank": {
    "iban": "DE89370400440532013000",
    "bankName": "Example Bank",
    "bic": "EXBKDE81XXX"
  },
  "creditorName": "ABC Corporation",
  "creditorIdentifier": "DE123456789",
  "creditorAddress": {
    "city": "Munich",
    "countryCode": "DE",
    "number": "456",
    "addressLine1": "Leopoldstr.",
    "postCode": "80807"
  },
  "account": {
    "customerAccountId": "CUST-12345",
    "billingAddress": {
      "city": "Berlin",
      "countryCode": "DE",
      "number": "123",
      "addressLine1": "Main Street",
      "postCode": "12345"
    },
    "isBusinessUser": true,
    "businessConsumer": {
      "companyName": "ABC Corporation",
      "companyType": "Limited Liability Company",
      "emailAddress": "contact@abccorp.com",
      "taxId": "DE987654321",
      "culture": "en_US"
    }
  },
  "additionalData": [
    {
      "name": "jpmcoid",
      "value": "12345"
    }
  ]
}

Create new fully filled mandate response

Status Code:

201 (OK)

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "id": "md_7c1c304e-72bf-2b57-2570-148879f6da20",
  "object": "MANDATE",
  "createdAt": "2023-03-02T14:25:59.078Z",
  "mandateScheme": "SEPA_B2B",
  "mandateReference": "SEPA-20230906-ABC123",
  "status": "CREATED",
  "referenceInstructions": {
    "mandatePrefix": "SEPA-20230906"
  },
  "debtorName": "John Doe",
  "debtorAddress": {
    "city": "Berlin",
    "countryCode": "DE",
    "number": "123",
    "addressLine1": "Main Street",
    "postCode": "12345"
  },
  "debtorBank": {
    "iban": "DE89370400440532013000",
    "bankName": "Example Bank",
    "bic": "EXBKDE81XXX"
  },
  "creditorName": "ABC Corporation",
  "creditorIdentifier": "DE98ZZZ09999999999",
  "creditorAddress": {
    "city": "Munich",
    "countryCode": "DE",
    "number": "456",
    "addressLine1": "Leopoldstr.",
    "postCode": "80807"
  },
  "account": {
    "customerAccountId": "CUST-12345",
    "billingAddress": {
      "city": "Berlin",
      "countryCode": "DE",
      "number": "123",
      "addressLine1": "Main Street",
      "postCode": "12345"
    },
    "isBusinessUser": true,
    "businessConsumer": {
      "companyName": "ABC Corporation",
      "companyType": "Limited Liability Company",
      "emailAddress": "contact@abccorp.com",
      "taxId": "DE987654321",
      "culture": "en_US"
    }
  },
  "additionalData": [
    {
      "name": "jpmcoid",
      "value": "12345"
    }
  ]
}

Get all SEPA mandates

The endpoint provides all mandates for the integrator making the request (identified by basicAuth).

Parameter	Explanation
status	CREATED - filters only mandates with the status created. ACTIVE - filters only mandates with the status active. CLOSED - filters only mandates with the status closed.
fromDate	Returns all mandates created on or after that date.
toDate	Returns all mandates created on or before that date.
cursor	First mandate after MandateId provided will be returned.
pageSize	Used for pagination, total number of results to return.

Get all mandates request URL

Path:

GET {baseURL}/mandates

Header:

Content-Type: application/json
Accept-Language: en_US

https://{baseURL}/mandates?status=CREATED&fromDate=2023-03-02&toDate=2023-03-02&cursor=md_7c1c304e-72bf-2b57-2570-148879f6da20&pageSize=25

Get all mandates response URL

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "meta": {
    "hasMore": false
  },
  "data": [
    {
      "id": "md_54c8e62b-f96a-4698-8323-783284873a68",
      "object": "MANDATE",
      "createdAt": "2023-03-02T14:25:59.078Z",
      "mandateScheme": "SEPA_B2B",
      "mandateReference": "SEPA-20230906-ABC123",
      "status": "CREATED",
      "creditorName": "ABC Corporation",
      "creditorIdentifier": "DE123456789",
      "creditorAddress": {
        "city": "Munich",
        "countryCode": "DE",
        "number": "456",
        "addressLine1": "Leopoldstr.",
        "postCode": "80807"
      }
    },
    {
      "id": "md_7c1c304e-72bf-2b57-2570-148879f6da20",
      "object": "MANDATE",
      "createdAt": "2023-03-02T14:25:59.078Z",
      "mandateScheme": "SEPA_B2B",
      "mandateReference": "SEPA-20230906-ABC123",
      "status": "CREATED",
      "referenceInstructions": {
        "generatedReference": true,
        "mandatePrefix": "SEPA-20230906"
      },
      "debtorName": "John Doe",
      "debtorAddress": {
        "city": "Berlin",
        "countryCode": "DE",
        "number": "123",
        "addressLine1": "Main Street",
        "postCode": "12345"
      },
      "debtorBank": {
        "iban": "DE89370400440532013000",
        "bankName": "Example Bank",
        "bic": "EXBKDE81XXX"
      },
      "creditorName": "ABC Corporation",
      "creditorIdentifier": "DE123456789",
      "creditorAddress": {
        "city": "Munich",
        "countryCode": "DE",
        "number": "456",
        "addressLine1": "Leopoldstr.",
        "postCode": "80807"
      },
      "account": {
        "customerAccountId": "CUST-12345",
        "billingAddress": {
          "city": "Berlin",
          "countryCode": "DE",
          "number": "123",
          "addressLine1": "Main Street",
          "postCode": "12345"
        },
        "isBusinessUser": true,
        "businessConsumer": {
          "companyName": "ABC Corporation",
          "companyType": "Limited Liability Company",
          "emailAddress": "contact@abccorp.com",
          "taxId": "DE987654321",
          "culture": "en_US"
        }
      },
      "additionalData": [
        {
          "name": "jpmcoid",
          "value": "12345"
        }
      ]
    },
    {
      "id": "md_456949e4-0406-44ed-8f1d-ebced96b02cf",
      "object": "MANDATE",
      "createdAt": "2023-03-02T14:25:59.078Z",
      "mandateScheme": "SEPA_B2B",
      "mandateReference": "SEPA-20230906-DEF456",
      "status": "ACTIVE",
      "referenceInstructions": {
        "mandatePrefix": "SEPA-20230906"
      },
      "debtorName": "Jane Smith",
      "debtorAddress": {
        "city": "Hamburg",
        "countryCode": "DE",
        "number": "789",
        "addressLine1": "Elm Street",
        "postCode": "54321"
      },
      "debtorBank": {
        "iban": "DE12345678901234567890",
        "bankName": "Another Bank",
        "bic": "ANBKDE81XXX"
      },
      "creditorName": "XYZ Ltd",
      "creditorIdentifier": "DE987654321",
      "creditorAddress": {
        "city": "Frankfurt",
        "countryCode": "DE",
        "number": "101",
        "addressLine1": "Oak Street",
        "postCode": "60000"
      },
      "activation": {
        "mandateSignedLocation": "Hamburg",
        "mandateDateOfSignature": "2023-09-10",
        "mandateAcceptance": "OFFLINE"
      },
      "account": {
        "customerAccountId": "CUST-67890",
        "billingAddress": {
          "city": "Hamburg",
          "countryCode": "DE",
          "number": "789",
          "addressLine1": "Elm Street",
          "postCode": "54321"
        },
        "isBusinessUser": false,
        "businessConsumer": {
          "companyName": "N/A",
          "companyType": "N/A",
          "emailAddress": "N/A",
          "taxId": "N/A",
          "culture": "en_GB"
        }
      }
    },
    {
      "id": "md_0bf4120b-d359-4d0e-b9d4-10bdd7b08919",
      "object": "MANDATE",
      "createdAt": "2023-03-02T14:25:59.078Z",
      "mandateScheme": "SEPA_CORE",
      "mandateReference": "SEPA-20240906-ABC567",
      "status": "ACTIVE",
      "referenceInstructions": {
        "generatedReference": false
      },
      "debtorName": "John Doe",
      "debtorAddress": {
        "city": "Berlin",
        "countryCode": "DE",
        "number": "123",
        "addressLine1": "Main Street",
        "postCode": "12345"
      },
      "debtorBank": {
        "iban": "DE89370400440532013000",
        "bankName": "Example Bank",
        "bic": "EXBKDE81XXX"
      },
      "creditorName": "ABC Corporation",
      "creditorIdentifier": "DE123456789",
      "creditorAddress": {
        "city": "Munich",
        "countryCode": "DE",
        "number": "456",
        "addressLine1": "Leopoldstr.",
        "postCode": "80807"
      },
      "account": {
        "customerAccountId": "CUST-12345",
        "billingAddress": {
          "city": "Berlin",
          "countryCode": "DE",
          "number": "123",
          "addressLine1": "Main Street",
          "postCode": "12345"
        },
        "isBusinessUser": true,
        "businessConsumer": {
          "companyName": "ABC Corporation",
          "companyType": "Limited Liability Company",
          "emailAddress": "contact@abccorp.com",
          "taxId": "DE987654321",
          "culture": "en_US"
        }
      },
      "additionalData": [
        {
          "name": "jpmcoid",
          "value": "12345"
        }
      ]
    }
  ]
}

Get SEPA mandate by ID

The endpoint returns mandates by ID in the chronological order.

Parameter	Explanation
mandateId	Mandate ID is required.

Get mandate by Id request URL

Path:

GET {baseURL}/mandates/{mandateId}

Header:

Content-Type: application/json
Accept-Language: en_US

https://{baseURL}/mandates/md_7c1c304e-72bf-2b57-2570-148879f6da20

Get mandate by Id response URL

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "id": "md_7c1c304e-72bf-2b57-2570-148879f6da20",
  "object": "MANDATE",
  "createdAt": "2023-03-02T14:25:59.078Z",
  "versionTag": "0001",
  "versionCreatedAt": "2023-03-02T14:25:59.078Z",
  "mandateScheme": "SEPA_B2B",
  "mandateReference": "SEPA-20230906-ABC123",
  "status": "ACTIVE",
  "referenceInstructions": {
    "mandatePrefix": "SEPA-20230906"
  },
  "debtorName": "John Doe",
  "debtorAddress": {
    "city": "Berlin",
    "countryCode": "DE",
    "number": "123",
    "addressLine1": "Main Street",
    "postCode": "12345"
  },
  "debtorBank": {
    "iban": "DE89370400440532013000",
    "bankName": "Example Bank",
    "bic": "EXBKDE81XXX"
  },
  "creditorName": "ABC Corporation",
  "creditorIdentifier": "DE98ZZZ09999999999",
  "creditorAddress": {
    "city": "Munich",
    "countryCode": "DE",
    "number": "456",
    "addressLine1": "Leopoldstr.",
    "postCode": "80807"
  },
  "activation": {
    "mandateSignedLocation": "Berlin",
    "mandateDateOfSignature": "2023-09-06",
    "mandateAcceptance": "ONLINE",
    "storedPaymentOptionReference": "8ac7a4a266c593040166d4b7d08e2201"
  },
  "account": {
    "customerAccountId": "CUST-12345",
    "billingAddress": {
      "city": "Berlin",
      "countryCode": "DE",
      "number": "123",
      "addressLine1": "Main Street",
      "postCode": "12345"
    },
    "isBusinessUser": true,
    "businessConsumer": {
      "companyName": "ABC Corporation",
      "companyType": "Limited Liability Company",
      "emailAddress": "contact@abccorp.com",
      "taxId": "DE987654321",
      "culture": "en_US"
    }
  },
  "additionalData": [
    {
      "name": "jpmcoid",
      "value": "12345"
    }
  ]
}

Update SEPA mandate

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.

Parameter	Explanation
mandateId	Mandate ID is required.

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.

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

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.

Update active mandate request

Path:

PUT {baseURL}/mandates/{mandateId}

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "debtorName": "{{customerFullName}}",
  "debtorAddress": {
    "city": "{{city}}",
    "number": "{{houseNumber}}",
    "addressLine1": "{{addr1}}",
    "postCode": "{{postCode}}",
    "countryCode": "IT"
    },
  "debtorBank": {
    "iban": "ES912***332",
    "bankName": "BNP",
    "bic": "CAIXESBBXXX"
    }
}

Update active mandate response

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en_US

{
    "referenceInstructions": {
        "mandatePrefix": ""
    },
    "debtorAddress": {
        "number": "0",
        "addressLine1": "VIA VILLA DEL VENEZIANO 13",
        "postCode": "46019",
        "city": "VIADANA",
        "countryCode": "IT"
    },
    "object": "MANDATE",
    "status": "ACTIVE",
    "createdAt": "2024-09-24T10:07:04.267Z",
    "creditorAddress": {
        "number": "35",
        "addressLine1": "Via Puglia",
        "postCode": "10156",
        "city": "Torino",
        "countryCode": "IT"
    },
    "versionCreatedAt": "2024-10-11T15:22:48.932Z",
    "creditorIdentifier": "IT123456789",
    "creditorName": "Iveco S.P.A.",
    "versionTag": "0006",
    "debtorName": "AUTOTRASPORTI FENICE SRL",
    "mandateScheme": "SEPA_B2B",
    "additionalData": [
        {
            "name": "jpmcoid",
            "value": "12345"
        }
    ],
    "account": {
        "customerAccountId": "0000219239",
        "billingAddress": {
            "addressLine1": "VIA VILLA DEL VENEZIANO 13",
            "number": "0",
            "postCode": "46019",
            "city": "VIADANA",
            "countryCode": "IT"
        },
        "isBusinessUser": true,
        "businessConsumer": {
            "emailAddress": "example@example.com",
            "companyType": "-",
            "taxId": "default",
            "culture": "en-it",
            "companyName": "AUTOTRASPORTI FENICE SRL"
        }
    },
    "activation": {
        "mandateAcceptance": "ONLINE",
        "mandateDateOfSignature": "2024-09-24T00:00:00.000Z",
        "storedPaymentOptionReference": "19b3e7e4a8a74de682d4eadccf182360"
    },
    "debtorBank": {
        "bic": "CAIXESBBXXX",
        "bankName": "BNP",
        "iban": "ES912***332"
    },
    "id": "d6623427-08ce-4cb8-b39a-03421d2463e8",
    "mandateReference": "CIG0210000000226"
}

Update inactive mandate

Update inactive mandate request

Path:

PUT {baseURL}/mandates/{mandateId}

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "debtorName": "{{customerFullName}}",
  "debtorAddress": {
    "city": "{{city}}",
    "number": "{{houseNumber}}",
    "addressLine1": "{{addr1}}",
    "postCode": "{{postCode}}",
    "countryCode": "IT"
    },
  "debtorBank": {
    "iban": "ES912***332",
    "bankName": "BNP",
    "bic": "CAIXESBBXXX"
    }
}

Update inactive mandate response

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en_US

{
    "referenceInstructions": {
        "mandatePrefix": ""
    },
    "debtorAddress": {
        "number": "0",
        "addressLine1": "VIA VILLA DEL VENEZIANO 13",
        "postCode": "46019",
        "city": "VIADANA",
        "countryCode": "IT"
    },
    "object": "MANDATE",
    "status": "CREATED",
    "createdAt": "2024-09-24T10:07:04.267Z",
    "creditorAddress": {
        "number": "35",
        "addressLine1": "Via Puglia",
        "postCode": "10156",
        "city": "Torino",
        "countryCode": "IT"
    },
    "versionCreatedAt": "2024-10-11T15:22:48.932Z",
    "creditorIdentifier": "IT123456789",
    "creditorName": "Iveco S.P.A.",
    "versionTag": "0006",
    "debtorName": "AUTOTRASPORTI FENICE SRL",
    "mandateScheme": "SEPA_B2B",
    "additionalData": [
        {
            "name": "jpmcoid",
            "value": "12345"
        }
    ],
    "account": {
        "customerAccountId": "0000219239",
        "billingAddress": {
            "addressLine1": "VIA VILLA DEL VENEZIANO 13",
            "number": "0",
            "postCode": "46019",
            "city": "VIADANA",
            "countryCode": "IT"
        },
        "isBusinessUser": true,
        "businessConsumer": {
            "emailAddress": "example@example.com",
            "companyType": "-",
            "taxId": "default",
            "culture": "en-it",
            "companyName": "AUTOTRASPORTI FENICE SRL"
        }
    },
      "debtorBank": {
        "bic": "CAIXESBBXXX",
        "bankName": "BNP",
        "iban": "ES912***332"
    },
    "id": "d6623427-08ce-4cb8-b39a-03421d2463e8",
    "mandateReference": "CIG0210000000226"
}

Delete SEPA mandate

This endpoint deletes an inactive mandate.

Parameter	Explanation
mandateId	Mandate ID is required.

Delete mandate request

Path:

DELETE {baseURL}/mandates/{mandateId}

Header:

Content-Type: application/json
Accept-Language: en_US

https://{baseURL}/mandates/md_7c1c304e-72bf-2b57-2570-148879f6da20

Delete mandate response

Path:

https://{baseURL}/mandates/{mandateId}

Status Code:

204 (Mandate deleted successfully)

Header:

Content-Type: application/json
Accept-Language: en_US

Activate SEPA mandate

This endpoint initiates the activation of a mandate, enabling it for payment processing.

Parameter	Explanation
mandateId	Mandate ID is required.

Activate mandate request

Path:

PUT {baseURL}/mandates/{mandateId}/activate

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "mandateSignedLocation": "string",
  "mandateDateOfSignature": "2024-08-22",
  "mandateAcceptance": "OFFLINE"
}

Activate mandate response

Path:

https://{baseURL}/mandates/md_7c1c304e-72bf-2b57-2570-148879f6da20/activate

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en_US

{
  "storedPaymentOptionReference": "string",
  "mandateSignedLocation": "string",
  "mandateDateOfSignature": "2024-08-22",
  "mandateAcceptance": "OFFLINE"
}

Cancel active SEPA mandate

This endpoint initiates a request for mandate cancellation, making it unusable for any future payment processing.

Parameter	Explanation
mandateId	Mandate ID is required.

Cancel mandate request

Path:

PUT {baseURL}/mandates/{mandateId}/cancel

Header:

Content-Type: application/json
Accept-Language: en_US

https://{baseURL}/mandates/md_7c1c304e-72bf-2b57-2570-148879f6da20/cancel

Cancel mandate response

Path:

https://{baseURL}/mandates/md_7c1c304e-72bf-2b57-2570-148879f6da20/cancel

Status Code:

204 (Mandate cancelled successfully)

Header:

Content-Type: application/json
Accept-Language: en_US

Base URLs & additional details​

Create SEPA mandate​

Create new empty mandate​

Create new empty mandate request​

Create new empty mandate response​

Create new partially filled mandate​

Create a new partially filled mandate request​

Create new partially filled mandate response​

Create new fully filled mandate​

Create new fully filled mandate request​

Create new fully filled mandate response​

Get all SEPA mandates​

Get all mandates request URL​

Get all mandates response URL​

Get SEPA mandate by ID​

Get mandate by Id request URL​

Get mandate by Id response URL​

Update SEPA mandate​

Update active mandate​

Update active mandate request​

Update active mandate response​

Update inactive mandate​

Update inactive mandate request​

Update inactive mandate response​

Delete SEPA mandate​

Delete mandate request​

Delete mandate response​

Activate SEPA mandate​

Activate mandate request​

Activate mandate response​

Cancel active SEPA mandate​

Cancel mandate request​

Cancel mandate response​

Base URLs & additional details

Create SEPA mandate

Create new empty mandate

Create new empty mandate request

Create new empty mandate response

Create new partially filled mandate

Create a new partially filled mandate request

Create new partially filled mandate response

Create new fully filled mandate

Create new fully filled mandate request

Create new fully filled mandate response

Get all SEPA mandates

Get all mandates request URL

Get all mandates response URL

Get SEPA mandate by ID

Get mandate by Id request URL

Get mandate by Id response URL

Update SEPA mandate

Update active mandate

Update active mandate request

Update active mandate response

Update inactive mandate

Update inactive mandate request

Update inactive mandate response

Delete SEPA mandate

Delete mandate request

Delete mandate response

Activate SEPA mandate

Activate mandate request

Activate mandate response

Cancel active SEPA mandate

Cancel mandate request

Cancel mandate response