API documentation

Holm Bank.API documentation

API Keys

Holm uses API key to allow access to the API. Key can be generated in Holmbank Partner System. To get an account and access to the partner system, please fill in the registration form on our website.

Production key will become available once you sign an agreement.

 You can generate the key under the General -> Store info page in partner system.

When generating new key, the old one will get invalidated.

Initiating a Loan Application

POST /api/partners/public/payment-link/orders

Header

KeyRequiredTypeDescription
x-payment-link-keyyesstring
 x-payment-link-req-idyesstringunique value generated by e-store

Payload

KeyRequiredTypeDescription
languagenostringen/et/ru
totalAmountyesfloat %.2fCart total amount (must equal with products totalPrice sum)
paymentTypeyesstringPRN_HP - Hire purchase, PRN_HP_LIISI3 - 3 equal payment without extra cost, PRN_HP_LIISI6 - 6 equal payment without extra cost
orderNumbernostringThe order reference in the merchant system
productsyesstringproduct array
returnUrlyesstringreturn Url

Payload: Products

KeyRequiredTypeDescription
productSKUnostring
productNameyesstringThe product's name
totalPriceyesfloat %.2fThe product's sale price (tax included)
quantityyesfloat %.2fQuantity of this product
{
    "language": "et",
    "totalAmount": 1189.94,
    "paymentType": "PRN_HP",
    "orderNumber": "M012adsf356",
    "products": [
        {
            "productSKU": "TB029982",
            "productName": "fan",
            "totalPrice": 389.98,
            "quantity": 2
        },
       {
            "productSKU": "TB029982",
            "productName": "pwm akregaat",
            "totalPrice": 599.97,
            "quantity": 3
        },
        {
            "productSKU": "TB029982",
            "productName": "soojusvahetiga vent",
            "totalPrice": 199.99,
            "quantity": 1
       }
   ],
"returnUrl":"holmbank.ee/return"
}
Please make sure that the totalPrice is price of the product multiply with quantity.

Redirecting the Customer

POST api/partners/public/orders/payment-link response will be orderLink and orderId. OrderId should save to e-shop

KeyRequiredTypeDescription
orderLinkyesstringlink where to redirect customer
orderIdyesstringunique id for order
{
    "orderLink": "https://eesti.hbc.nonprod.holmbank.ee/et/eraklient/self-service/payment-link/e039ed2a-c9d0-46e0-97cb-f9b989db9942",
    "orderId": "e039ed2a-c9d0-46e0-97cb-f9b989db9942"
}

Validating the Financing Application

Redirect Back to the Merchant

Once the customer completes the financing contract, they will be redirected back to the returnUrl that you set in the original POST request. Customers redirection url contains orderId and status. Statuses will be APPROVED, PENDING, REJECTED.

mingiepood.ee/return?orderId=0fe6e06d-b90e-417c-89dc-e93fcfe96c2b&status=APPROVED

APPROVED - positive flow
REJECTED - negative flow, canceled, terminated.
PENDING - waiting customers final approve (a'ka down payment)

Order status request to Merchant

Partner backend will send POST request about contract status with payload.

Header

KeyRequiredTypeDescription
 x-payment-link-req-idyesstring

Payload

KeyRequiredTypeDescription
orderIdyesstringsame orderId what was response to order request
statusyesstringAPPROVED, PENDING, REJECTED
contractNumbernostringContract number in Holm Partner system

After PENDING status will follow APPROVED or REJECTED.

Allowed loan products to Merchant

In some case there are possible to have more than one loan product in store (hire-purchase, Liisi3 etc). GET /api/partners/public/payment-link/products

Request Header

KeyRequiredTypeDescription
x-payment-link-keyyesstring

Response

KeyTypeDescription
idstringuuid
typestringPRN_HP, PRN_HP_LIISI3
namestringJärelmaks, Liisi3
validFrom
validTo

Enviroments

Sandbox
https://wiremocks.nonprod.holmbank.ee/api/partners/public/payment-link/orders
Live
https://gateway-partner.hbc.holmbank.ee

Oled finantsteenuse pakkuja Holm Bank AS kodulehel. Enne iga lepingu sõlmimist tutvu tingimustega ning vajadusel konsulteeri asjatundjaga.
© 2022. Holm Bank AS