# Configure the extension

To perform a SCHUFA Credit Report in your shop, you must first apply for a SCHUFA account and configure your SCHUFA API access data. Follow our [step-by-step instructions](https://docs.premsoft.de/en/plugins/schufa-credit-report/installation/prepare-your-schufa-account) for more information.

### SCHUFA API

This section stores the access data required to connect to SCHUFA.

<figure><img src="https://747417571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYYTKTU6awfIFbvBGavuX%2Fuploads%2F1GYLUXS27Ri2UyNsELBT%2FSCHUFA_API_EN.png?alt=media&#x26;token=928a8c28-484e-45cd-abe3-968252e4f4f5" alt=""><figcaption></figcaption></figure>

| Field                        | Type           | Description                                                                                                                                    |
| ---------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Mode                         | Select field   | Choose between test and live mode. Always verify the extension behavior in test mode first. Only SCHUFA test datasets may be used for testing. |
| Public certificate key file  | File upload    | Upload the file containing the public certificate key you received from SCHUFA. This file has the extension **certs.pem**.                     |
| Private certificate key file | File upload    | Upload the file containing the private certificate key you received from SCHUFA. This file has the extension **key.pem**.                      |
| Key password                 | Password field | Enter the password used to protect your certificate key file.                                                                                  |
| Participant ID               | Text input     | You receive the participant ID from SCHUFA via email.                                                                                          |
| Participant password         | Password field | Store the participant password SCHUFA provided via email.                                                                                      |

{% hint style="info" %}
After saving, click **Check credentials** to verify the API data.\
You will see either a success or an error message.
{% endhint %}

### Configuration

General settings for using the extension.

<figure><img src="https://747417571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYYTKTU6awfIFbvBGavuX%2Fuploads%2F9NzHZ8KwBRq1477F3WEY%2FConfiguration_EN.png?alt=media&#x26;token=6b5b43f0-52b7-499e-89d4-5f1de4af9d3e" alt=""><figcaption></figcaption></figure>

| Field                     | Type            | Description                                                                                                                                                                                     |
| ------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Minimum cart value in EUR | Numerical input | Set a minimum net cart value. SCHUFA checks will only run once this threshold is reached.                                                                                                       |
| Log level                 | Select field    | Controls whether debug information or only errors are written to the shop log file. In live operation, log only errors. Otherwise the log file can grow quickly.                                |
| Enable cache              | Toggle          | Enables caching of SCHUFA checks, both in custom fields and in the user's session. Disable caching only in test mode for troubleshooting. Otherwise you will trigger unnecessary SCHUFA checks. |

### Score Cart B2C

This section shows the SCHUFA score levels for B2C customers. It is split into these columns:

* Rating Level
* Risk rate in %
* Maximum cart value in EUR
* Retention time in days

<figure><img src="https://747417571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYYTKTU6awfIFbvBGavuX%2Fuploads%2FRIpTaz0XhgqnoDNOkRy0%2FB2C_List_EN.png?alt=media&#x26;token=48e030f3-2c7f-4d29-955c-37a27d0a80dd" alt=""><figcaption></figcaption></figure>

The **Rating Level** and the **risk rate** are SCHUFA’s assessment of the requested customer.\
The **maximum cart value** limits the net cart value allowed for the respective risk rating. If the cart value is exceeded, the payment method is blocked automatically, even if it would be allowed based on the customer’s creditworthiness.\
The **retention time in days** defines how long a customer’s request is stored in the shop before a new SCHUFA check is triggered for a later order.

**Rating Level** and **risk rate** are fixed values and cannot be changed.\
**Maximum cart value** and **retention time** can be adjusted.

### Adjusting the shopping cart value and storage time B2C

Click the three dots (**...**) on an entry and choose **Edit**.\
This opens the edit screen. The fields **Rating Level** and **risk rate** cannot be changed, because SCHUFA provides these values via the API.

<figure><img src="https://747417571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYYTKTU6awfIFbvBGavuX%2Fuploads%2FKC5qejFAMpGHFC3wnykB%2FB2C_Detail_EN.png?alt=media&#x26;token=1018c946-b223-4ab2-8da5-a5c77d4765f6" alt=""><figcaption></figcaption></figure>

| Field                     | Type            | Description                                                                                                                    |
| ------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Rating Level              | Disabled field  | SCHUFA rating level                                                                                                            |
| Risk rate in %            | Disabled field  | SCHUFA risk rate                                                                                                               |
| Maximum cart value in EUR | Numerical input | Set the maximum allowed net cart value (EUR) for customers with the rating level / risk rate stored in this entry.             |
| Retention time in days    | Numerical input | Defines how many days a successful SCHUFA check is stored. If a user orders again within this time, no new check is triggered. |

To save your changes, click **Save**. To return to the list view, click **Cancel**.

### Score Cart B2B

This section shows the SCHUFA score levels for B2B customers. It is split into these columns:

* Credit rating index
* Risk rate in %
* Maximum cart value in EUR
* Retention time in days

<figure><img src="https://747417571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYYTKTU6awfIFbvBGavuX%2Fuploads%2FJlyaFskWptxOEbihUyUC%2FB2B_List_EN.png?alt=media&#x26;token=90221210-2cb2-4639-b62a-0fb2835d01c5" alt=""><figcaption></figcaption></figure>

The **credit rating index** and the **risk rate** are SCHUFA’s assessment of the requested customer.\
The **maximum cart value** limits the net cart value allowed for the respective risk rating. If the cart value is exceeded, the payment method is blocked automatically, even if it would be allowed based on the customer’s creditworthiness.\
The **retention time in days** defines how long a customer’s request is cached in the shop before a new SCHUFA check is triggered for a later order.

**Credit rating index** and **risk rate** are fixed values and cannot be changed.\
**Maximum cart value** and **retention time** can be adjusted.

### Adjusting the shopping cart value and storage time B2B

Click the three dots (**...**) on an entry and choose **Edit**.\
This opens the edit screen. The fields **credit rating index** and **risk rate** cannot be changed, because SCHUFA provides these values via the API.

<figure><img src="https://747417571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYYTKTU6awfIFbvBGavuX%2Fuploads%2FotKn4pUJpr2ncLfOpp24%2FB2B_Detail_EN.png?alt=media&#x26;token=71b2838c-c1e7-42a7-8743-6de5d5b13939" alt=""><figcaption></figcaption></figure>

| Field                     | Type            | Description                                                                                                                    |
| ------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Credit rating index       | Disabled field  | SCHUFA credit rating index                                                                                                     |
| Risk rate in %            | Disabled field  | SCHUFA risk rate                                                                                                               |
| Maximum cart value in EUR | Numerical input | Set the maximum allowed net cart value (EUR) for customers with the risk rate stored in this entry.                            |
| Retention time in days    | Numerical input | Defines how many days a successful SCHUFA check is stored. If a user orders again within this time, no new check is triggered. |

To save your changes, click **Save**. To return to the list view, click **Cancel**.

### Configuring payment methods for SCHUFA Credit Report

If a payment method should only be available after a positive SCHUFA Credit Report, you must configure this on the payment method.

{% hint style="warning" %}
A SCHUFA check may only be performed for payment methods that carry a default risk for the shop owner.\
These are: **purchase on account** and **SEPA direct debit**.
{% endhint %}

In the Shopware administration, go to **Settings > Shop > Payment methods**, select the payment method, and click **Edit details**.\
This opens the payment method edit screen. Scroll down to the custom fields section.\
Enable the risk check by toggling **Enable SCHUFA risk check**.

{% hint style="info" %}
If the shop is multilingual, please apply this setting for the default language or for each language to disable inheritance.
{% endhint %}

<figure><img src="https://747417571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYYTKTU6awfIFbvBGavuX%2Fuploads%2FKzFWCDgt63ztYXXJbX1Z%2Fimage.png?alt=media&#x26;token=fee2f873-9321-4b28-8201-04d77a10ccce" alt=""><figcaption></figcaption></figure>
