DOCSEARCHbyAlgolia
Submit Docs

Home Credit Financing API Reference

website·Indexed 29 days ago

https://openapi-schema.hc-docs.pages.dev/

API documentation for Home Credit financing services, featuring endpoints for application creation, offer calculation, precheck scorings, and order management across v1, v2, and v3 versions. Includes guides on process flow, GDPR compliance, communication security, and minimum functional requirements.

Tokens
9.8K
Snippets
49
Records
77
Agent score
74%

What's inside Home Credit Financing API

  4. Search financing applications using GET /rest/financing/v2/applications

    Retrieve a list of financing applications by sending a GET request to /rest/financing/v2/applications. To access this endpoint, the authenticated user must have the applications.overview authority. Possible HTTP response codes include 200 (OK), 401 (Unauthorized), 403 (Forbidden), and 404 (Not Found).
    GET /rest/financing/v2/applications

  5. Retrieve order details via the Financing API

    Use the GET /rest/financing/v1/orders endpoint to retrieve order information. To successfully call this endpoint, the authenticated user must have the applications.overview authority. Possible HTTP response codes include 200 (OK), 401 (Unauthorized), 403 (Forbidden), and 404 (Not Found).
    curl -X GET "https://<api-domain>/rest/financing/v1/orders" \
     -H "Authorization: Bearer <token>"

  6. Choose a payment calculator implementation method

    Home Credit offers three ways to implement the payment calculator in production:

    1. Partner's Own Solution: Built using calculation endpoints. This offers full control over the UI and UX but is the most development-intensive.
    2. JavaScript Widget: A hybrid approach using a Home Credit JS widget for the frontend and offer calculations, while the partner's backend handles the loan application creation. Widget source: https://github.com/homecreditcz/widget-calculator.
    3. External Repayment Calculator: A simple link redirection to a Home Credit-hosted page. Required for 'Tipař' mode partners.

  7. Retrieve a financing application by UUID

    Use the GET /rest/financing/v2/applications/:uuid endpoint to retrieve details for a specific financing application. The authenticated user must have the applications.overview authority to access this resource. Possible responses include 200 (OK), 401 (Unauthorized), 403 (Forbidden), and 404 (Not Found).
    GET /rest/financing/v2/applications/{uuid}

  8. Obtain an access token for Home Credit API

    To make authorized calls to the financing endpoints, you must first obtain a bearer access token by sending a POST request with your test environment credentials.

    Endpoints

    • CZ: https://apicz-test.homecredit.cz/verdun-train/authentication/v1/partner
    • SK: https://apisk-test.homecredit.sk/verdun-train/authentication/v1/partner

    Request

    Header: Content-Type: application/json; charset=UTF-8 Body:

    {
  "username": "testovaciusername",
  "password": "test"
}

    Response

    {
  "expiresIn": 7200,
  "accessToken": "25167daf5c0d489f8b50ab685004ad5f",
  "tokenType": "bearer"
}

  9. Contact Home Credit support for assistance

    For questions or issues related to Home Credit (including Skip Pay), use the following support channels:

    • FAQ: Visit the FAQ section on the official website for common questions.
    • Email: Contact support at @homecredit.cz.
    • Phone: Call the support team at +420 222 222 xxx during business hours for immediate assistance.

  10. Verify the authenticity of transmitted notifications using HMAC-SHA512

    Notifications sent to partner e-shops include a checkSum attribute to prevent information tampering. This checksum is generated by concatenating the order number (orderNumber) and the request status (stateReason) separated by a colon, and then hashing that string using the HMAC hash function with the SHA512 algorithm and a shared secret key.

    Checksum Construction:

    1. Create a string in the format: {orderNumber}:{stateReason}
    2. Hash this string using HMAC-SHA512 with the provided secret key.
    3. Compare the result with the checkSum attribute in the message body.

    Secret Key Acquisition:

    • Test Environment: Available in the project's technical wiki.
    • Production Environment: Provided by the Home Credit (HC) representative during integration meetings.
    // Example Construction
Order Number: 018884
State Reason: PROCESSING_SIGNED
Secret Key: n#z?9:;a%&(\*er2

String to hash: "018884:PROCESSING_SIGNED"
Resulting Checksum: f61c69a259b702d564b2032e554984dec3b713ff7bdde17fcb727d403ea0d730816f46ad2bbc06a1914225d5dfba0396927dbf1b0698081 814877b5486950a15

  11. Implement the Home Credit installment purchase flow

    The purchase process for Home Credit installments follows these sequential steps:

    1. Product Calculator: Use the API, JavaScript widget, or standalone calculator in product details. If 'Installments' is selected, redirect the user to the cart with the payment method preset to installments.
    2. Shopping Cart: Display the selected installment option. If the cart total changes (e.g., added accessories), the calculator must be triggered again to ensure the correct installment plan for the new price.
    3. Order Completion: The customer completes the order on the e-shop.
    4. Application Creation: Call the createApplication API and redirect the customer to Home Credit to provide necessary information.
    5. Assessment: Home Credit assesses the application and notifies the customer of the result.
    6. Redirect: The customer is redirected back to the e-shop to either an approval or rejection URL provided by the merchant.
    7. Post-Assessment Page: Display a 'Thank You' page for approvals or prompt for an alternative payment method for rejections.
    8. Order Status Notifications: The e-shop receives notifications when the order status becomes READY_TO_SHIP.
    9. Shipment/Delivery Confirmation: Confirm shipment (via API/Webclient) or confirm delivery (via API). These are mutually exclusive; do not combine both.
    10. Finalization: Home Credit verifies delivery and processes the payment.

  12. Implement GDPR compliance text for Home Credit payment methods

    To comply with GDPR requirements, the following clickable or scrollable text must appear on the website during the shopping cart process for the Home Credit payment method:

    Czech Republic (CZ): "You acknowledge that your personal data, including your first name, last name, address, email, and phone number, will be transferred to Home Credit a.s., Nové sady 996/25, 602 00 Brno, IČO 26978636, e-mail: info@homecredit.cz, registered in the Commercial Register maintained by the Regional Court in Brno, Section B, File 4401 (hereinafter referred to as 'HC') for the purpose of pre-filling the service request form."

    Slovakia (SK): "You acknowledge that your personal data, including your first name, last name, address, e-mail, and telephone number, will be provided to Home Credit Slovakia, a.s., Teplická 7434/147, Piešťany 921 22, ID No. 36 234 176, e-mail: posta@homecredit.sk, registered in the Commercial Register maintained by the District Court of Trnava, Section Sa, File No. 10130/T for the purpose of pre-filling the application for the provision of services"