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.
When generating new key, the old one will get invalidated.
Initiating a Loan Application
POST /api/partners/public/payment-link/orders
Header
| Key | Required | Type | Description |
|---|---|---|---|
| x-payment-link-key | yes | string | |
| x-payment-link-req-id | yes | string | unique value generated by e-store |
Payload
| Key | Required | Type | Description |
|---|---|---|---|
language | no | string | en/et/ru |
totalAmount | yes | float %.2f | Cart total amount (must equal with products totalPrice sum). 2 digits after decimal point |
paymentType | yes | string | PRN_HP - Hire purchase, PRN_LIISI3 - 3 equal payment without extra cost |
| orderNumber | no | string | The order reference in the merchant system |
| products | yes | string | product array |
| returnUrl | yes | string | return Url |
Payload: Products
| Key | Required | Type | Description |
|---|---|---|---|
| productSKU | no | string | |
| productName | yes | string | The product's name |
| totalPrice | yes | float %.2f | The product's sale price (tax included). 2 digits after decimal point (totalPrice = single product price * quantity) |
| quantity | yes | float %.2f | Quantity of this product |
Redirecting the Customer
POST api/partners/public/orders/payment-link response will be orderLink and orderId. OrderId should save to e-shop
| Key | Required | Type | Description |
|---|---|---|---|
| orderLink | yes | string | link where to redirect customer |
| orderId | yes | string | unique id for order |
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.
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
| Key | Required | Type | Description |
|---|---|---|---|
| x-payment-link-req-id | yes | string |
Payload
| Key | Required | Type | Description |
|---|---|---|---|
orderId | yes | string | same orderId what was response to order request |
status | yes | string | APPROVED, PENDING, REJECTED |
contractNumber | no | string | Contract 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
| Key | Required | Type | Description |
|---|---|---|---|
| x-payment-link-key | yes | string |
Response
| Key | Type | Description |
|---|---|---|
| id | string | uuid |
type | string | PRN_HP, PRN_HP_LIISI3 |
name | string | Järelmaks, Liisi3 |
| logoUrl | strin | ...svg |
Enviroments
Sandbox
https://wiremocks.nonprod.holmbank.ee/api/partners/public/payment-link/orders
Live
https://gwp.holmbank.ee
Holm Bank AS
Posti 30, 90504 HaapsaluPärnu mnt. 158/1, 11317 Tallinn
Äriregistrikood
14080830
