REST API (EN)

The konfipay API is a powerful web service based on the principles of REST (Representational State Transfer). REST is a widely used standard for developing web services, known for its simplicity, flexibility, and platform independence. The API uses typical REST characteristics, such as HTTP verbs (e.g., GET, POST, PUT, DELETE) to perform operations, standardized HTTP status codes to communicate successes or errors, and content negotiation to provide data in the optimal format based on the client's requirements.

For secure data transmission, the HTTP (Hypertext Transfer Protocol) is used in combination with TLS (Transport Layer Security). TLS ensures encrypted and tamper-proof communication between the client and server, guaranteeing the confidentiality and integrity of the transmitted information.

The API supports JSON (JavaScript Object Notation) as the data format. JSON is a compact and easily readable format widely used due to its simple structure and compatibility with modern web applications.

The functionality of the konfipay API includes various banking services in accordance with the SEPA standard (Single Euro Payments Area), which standardizes and simplifies cross-border payments within Europe. In addition, the API allows access to a PayPal account to retrieve transactions and account balances, as well as to process refunds. This combination of SEPA and PayPal functionalities makes the API a versatile solution for modern payment processing.

Contents of This Article

This article covers two key aspects of the konfipay API in detail:

1. API Error Codes:

   • A comprehensive overview of the various error codes returned by the API in the event of errors or invalid requests is provided.

   • The error codes are divided into different categories and follow a structured format using the scheme ERR-{Category}-{Number}. Each category covers a specific area, such as invalid parameters, validation errors, or processing errors.

   • Each error code is accompanied by a detailed description that explains the cause of the error and, if applicable, the necessary steps to resolve it.

2. Description of API Versions:

   • The konfipay API is continuously developed to provide new features and optimize existing processes.

   • This article presents the different API versions, including the supported functionalities, key changes, and compatibility with older versions.

   • Special attention is given to indicating which features are available in each version and which version is recommended for specific use cases.

With the structured presentation of the error codes and the detailed description of the various API versions, this article serves as a comprehensive reference for developers looking to integrate the konfipay API into their applications.