Basic information for partner e-shops
The interface for the HC On-line payment method is a REST API, where JSON notation is used for all communication (queries - requests and responses) and data description.
Integration overviewβ
Integration is built around four simple steps. For each step you can choose the option that best fits your stackβfrom full API control to minimal integration.
1
π
Calculator
2
π
Create application
3
π
Notifications
4
π¦
Fulfillment
1. π Calculator in product detailβ
Let customers see installment options on your product page. Choose one of three approaches:
| Option | Description | Reference |
|---|---|---|
| API | Your own design; we return the values. Only for certified intermediaries under Act 257/2016 Sb. | PSP: Installments calculator resources eshop: Installments calculator resources |
| Widget | JavaScript widget embedded in your e-shop (download here). Only for certified intermediaries under Act 257/2016 Sb. | JavaScript widget integration |
| Standalone | "Link only" to usβopens our calculator in a new window or tab. | Standalone |
2. π Create applicationβ
Create the application via API and send the customer to us to complete it.
- Authentication: PSP: Login partner - eshop: Login partner (
authentication/v1/partner) - Create application: PSP: Create application (
financing/v3/applications) - eshop: Create application (financing/v1/applications) - Redirect the customer to the
gatewayRedirectUrlreturned in the response so they can complete the application on our side.
3. π Notificationsβ
Stay in sync with application status. Choose one of three options:
| Option | Description | Reference |
|---|---|---|
| Notification endpoint | We call your API whenever the application status changes. | PSP: Application notification - eshop: Application notification |
| Webservice | You query us via API for the current application status ("GET application detail"). | PSP: Get application - eshop: Get application |
| Webclient + email | Manual check in the web application, with email notifications. | β |
4. π¦ Fulfillment: shipped and deliveredβ
Confirm that the order was sent and/or delivered. Choose how to report:
| Option | Description | Reference |
|---|---|---|
| Mark as shipped | Confirm dispatch via API. | PSP: Mark order as shipped - eshop: Mark order as shipped |
| Mark as delivered | Confirm delivery to the customer via API. | PSP: Mark order as delivered - eshop: Mark order as delivered |
| Webclient | Confirm manually after signing in to the web application. | β |
Links and further informationβ
- The Technical Documentation for the API (hereinafter TD) and basic description of the payment method functionality can be found here
- A publicly accessible repository with supporting data is available at https://github.com/homecreditcz, where you will find:
- This guide to the public API including tutorials and sample data
- Installment calculator in the form of a JavaScript widget (widget-calculator)
- PHP script providing basic functionality necessary for integrating HC payment into your e-shop (php-script)
- PHP library providing basic functionality necessary for integrating HC payment into your e-shop (oneclick-api-client) - WARNING - DEPRECATED - only for PHP 5.6!!!