API settings
Info
Direct link: konfipay (DE) | konfipay (CH)
Navigation path: Client management > API > API settings
Quick navigation: API Einstellungen
User groups: Admin, Full access, Management
Required permissions: View/Edit API Settings
General information
The API settings allow an adjustment of the konfipay API to the individual needs of the respective application scenario. The API settings are divided into two categories: Checks and actions.
Checks
Checks are used to detect syntactic and/or logical errors in order to identify problems as early as possible in the payment processing process. Since different bank data centers have different levels of tolerance for errors, each check can be activated or deactivated individually in order to adapt it to the check criteria of the account-holding credit institution.
Checks | Description |
|---|---|
SEPA participating country | Check whether the IBAN of the opposing party of the credit transfer or direct debit belongs to a SEPA participating country. Applies only to payment formats which are subject to the SEPA country restriction. |
IBAN validation | Validation of the IBAN by calculating and matching the check digit. |
IBAN/BIC affiliation | Check that IBAN and BIC belong together. |
XML schema validation | Validation of the submitted files against the referenced XML schema. |
RDT character set check | Checking the files against the character set allowed in the DFÜ agreement. For this check, you can choose between the "Standard character set" and the "Extended character set". Only applies to files which are subject to the DFÜ character set restriction. |
EPC/DK rules | Review of restrictions and rules of the European Payment Council and the Deutsche Kreditwirtschaft. |
Checking the control values | Verification of the number of payments and the control total indicated in the file against the actual values. |
AZV file check | Verification of structure and content for foreign transfers in DTAZV format. |
Double submission | Check if the same file has already been submitted within a defined time period. The period can be set individually (1 to 48 hours). |
Address verification for direct debits outside the EU | Verification that the debtor's address is included in the direct debit. If the debtor's account-holding credit institution is located outside the EU, it is mandatory to provide the address. |
Checking the EBICS order type | Verification that the EBICS contact used to execute a payment has the necessary order type. |
Execution date | Verification of the execution date for submitted payment orders. The execution date must not be in the past. |
Creditor identification number | Verification of Creditor Identifier for submitted payment orders. |
Unique Message ID | Check for uniqueness of the message ID. |
Offline account creation | Setting to specify whether the creation of offline accounts via the API is allowed. If deactivated, the creation of offline accounts via the API is prevented. Offline accounts are not linked to any EBICS contact and have no connection to a service data center. |
Actions
Actions lead to an active change of the transferred data or to changes in the dataset of konfipay to optimize workflows or to correct errors in the transferred data automatically if the corresponding condition is met. The actions are disabled by default and must be actively selected by the user.
Action | Description |
|---|---|
Conversion of not allowed characters | Automatic conversion of disallowed characters (according to DFÜ agreement) for SEPA payments. |
Create bank accounts automatically | Automatic creation of bank accounts from payment files. |
Conversion from COR1 to CORE | COR1 is no longer supported as a direct debit type. |
Format banking XML files | Bank XML files are output formatted (line breaks and indentations). |
XML declaration in banking XML files | The XML declaration <?xml version='1.0' encoding='utf-8' ?> is prepended to banking XML files. |
Conversion of outdated payment order files | Payment order files in SEPA pain format are automatically upgraded to a current version. The conversion is performed exclusively for versions which are no longer valid according to the DFÜ agreement, according to the following scheme:
|
Asynchronous file processing | Payment files are processed asynchronously after submission. Recommended for large files (>2 MB). |
Conversion of payment order files to country-specific formats | Automatic conversion of submitted SEPA payments into the country-specific target format. The target format is based on the ISO country code of the respective EBICS contact.
Legend
Transfers  Direct debits  |
Conversion is not provided. The original document is returned.
Conversion is not possible (unknown pain formats or serious differences in source and destination XSD scheme). 
Conversion is possible: depending on the assignment of the fields, errors may occur.