SEPA

Last changes: 09-18-2020


  1. Get Financial Institution Data
  2. Initiate Storing of New Payment Option
  3. Collect Payment Option Details via SDK
  4. SEPA Mandate Acceptance Page
  5. Complete Storing of ew Payment Option

 

1. Get Financial Institution Data

Before initializing the authorization process, call the API method 1.84 Get Financial Institution Data.

Get Financial Institution Data Request

Path:

GET {Base URL}/settings/getFinancialInstitutionData?localDate=2017-08- 21&localTime=170911&partnerReference=TEST-4H363TJC68

Header:

Content-Type: application/json
Accept-Language: en-US

This will provide you with information about the financial institution, which will act as a Creditor in the SEPA Direct Debit process. This information is necessary for the SEPA Mandate Acceptance Page.

Get Financial Institution Data Response

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
    "name": "Volkswagen Payments S.A. (SANDBOX)",
    "addr1": "19-21, Route d’Arlon",
    "city": "Luxembourg",
    "state": "Strassen",
    "countryName": "Germany",
    "countryCode": "DE",
    "countryCode3": "DEU",
    "postCode": "L-8009",
    "creditorIdentifier": "DE98ZZZ09999999999",
    "contactPhone": "+49 892 488 5811",
    "contactEmail": "test.user.002@kontocloud.com",
    "partnerReference": "DEV-SVR001-DE_CUSTID-T8933PXJPK_CARTID-DJ7JKK662D_FK8K3MPJBQ",
    "localDate": "2018-10-24",
    "localTime": "093028",
    "sysDate": "2018-10-24",
    "sysTime": "073028",
    "responseCode": "0000",
    "responseDescription": "Successful execution"
}

2. Initiate Storing of New Payment Option

3. Collect Payment Option Details via SDK

4. SEPA Mandate Acceptance Page

Each mandate must include certain mandatory legal wording and mandatory information. The page collects not only the details of customer (name, address, etc.) and creditor information (see 1. Get Financial Institution data), but also the mandate parameters (Mandate Reference Number, Date, Time). You must display the following standard authorization text (replacing {FI name} with the name of the creditor) clearly visible and close to the accept button.

We suggest to display the mandate in a modal window as depicted in the mockup below.

With accepting the SEPA Mandate, the customer authorizes you to collect payments for the specified amount from their bank account using SEPA Direct Debit and is redirected to the specified “callbackURL”.

5. Complete Storing of New Payment Option

The "responseCode" 0000 and the “responseDescription” indicate that the new payment option has been successfully stored.

The storedPaymentOptionReference" parameter is used to identify the tokenized payment option as part of other API methods (see section Payment Process). You can either store it on your server or retrieve it via an API call (see section Get Stored Payment Options).