Additional Resources

Additional resources refer to supplementary tools that are available to enhance partner experience, address specific needs, offer guidance, and improve the overall usability of the products.

Refunds

Inbank has both full and partial returns available over API, you can find more information on full refunds in the Merchant Withdrawal section and on partial returns in the Partial Returns Guide.

ePOS Short Flow

ePOS Short Flow is applicable for cases when the partner would like to send the credit application over API and redirect the customer to Inbank's ePOS environment for contract signing. Please note, that this flow is available only in Estonia at the moment and should be pre-agreed with Inbank before integration.

You can find the detailed description of the flow in the ePOS Short Flow Guide.

Omniva Identification

The endpoints in this section apply when the customer is to undergo physical identification in one of the Omniva branches. The process applies to Estonia only. These endpoints are part of the Direct API flow and can be used after retrieving the contract details.

Omniva Branches

GET /partner/v2/shops/:shop_uuid/omniva/branches

To offer the customer to choose the Omniva branch where they would like to be identified, the list of available Omniva branches should be retrieved using the GET /partner/v2/shops/:shop_uuid/omniva/branches request.

The response includes the Omniva branches available for selection.

SecuritybearerAuth
Request
path Parameters
shop_uuid
required
string

The unique identifier of the shop.

Example: 38571c75-2590-4c81-8252-531613c96363
Responses
200

Return list of Omniva branches

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/partner/v2/shops/{shop_uuid}/omniva/branches
Request samples 
Response samples 
application/json
{
  • "omniva_branches": [
    ]
}
Omniva Branch Submission
PATCH /partner/v2/shops/:shop_uuid/customers/:customer_uuid/omniva/identification


To send the Omniva branch selected by the customer for identification, the 

PATCH /partner/v2/shops/shops/:uuid/customers/:customer_uuid/omniva/identification request should be used.


To send the selected branch, the e-shop needs to know the customer UUID, which is in the response to the GET /contracts/:contract_uuid request.


SecuritybearerAuth 
Request 
path Parameters
shop_uuid
required
string
The unique identifier of the shop.


 
 Example:  38571c75-2590-4c81-8252-531613c96363
customer_uuid
required
string
The unique identifier of the customer.


 
 Example:  fac6e447-aa40-48ec-a65d-a4acb24eceb6
Request Body schema: application/json
id
required
string
The ID of the selected Omniva branch. The IDs are returned in the response to the GET /omniva/branches request.


 
Responses 
200
Send the selected Omniva branch


401
Unauthorized


403
Forbidden


404
Not Found


500
Internal Server Error


patch/partner/v2/shops/{shop_uuid}/customers/{customer_uuid}/omniva/identification
Request samples 
application/json
{
  • "branch_id": "3"
}
Response samples 
application/json
{
  • "success": true
}
Add or Update Application Purchase
PUT /partner/v2/shops/:shop_uuid/applications/:application_uuid/purchase/:purchase_uuid


If the application already includes a purchase, this request updates its details. If there is no purchase in the application, the request creates a purchase with the details indicated in the body.


SecuritybearerAuth 
Request 
path Parameters
shop_uuid
required
string
The unique identifier of the shop.


 
 Example:  38571c75-2590-4c81-8252-531613c96363
application_uuid
required
string
The unique identifier of a particular credit application.


 
 Example:  471e6282-3384-412b-af7b-646eb8f04391
purchase_uuid
required
string
The unique identifier of a specific purchase within a credit application.


 
 Example:  1234
Request Body schema: application/json
object
 
Responses 
200
Added or updated application purchase


401
Unauthorized


403
Forbidden


404
Not Found


500
Internal Server Error


put/partner/v2/shops/{shop_uuid}/applications/{application_uuid}/purchase/{purchase_uuid}
Request samples 
application/json
{
  • "purchase": {
    }
}
Response samples 
application/json
{
  • "purchase": {
    }
}
Update Application Purchase Items
PUT /partner/v2/shops/:shop_uuid/applications/:application_uuid/purchase/:purchase_uuid/items


Update the details of purchase items in the application. If there were previously specified purchase items, they will be removed and replaced with data from the request body.


Note, that to add a purchase item, at least one parameter should be passed in the request body. For example, it is possible to create a purchase item with only its serial number indicated.


SecuritybearerAuth 
Request 
path Parameters
shop_uuid
required
string
The unique identifier of the shop.


 
 Example:  38571c75-2590-4c81-8252-531613c96363
application_uuid
required
string
The unique identifier of a particular credit application.


 
 Example:  471e6282-3384-412b-af7b-646eb8f04391
purchase_uuid
required
string
The unique identifier of a specific purchase within a credit application.


 
 Example:  1234
Request Body schema: application/json
Array of objects (purchaseItems) 
 
Responses 
204
Updated application purchase items


401
Unauthorized


403
Forbidden


404
Not Found


500
Internal Server Error


put/partner/v2/shops/{shop_uuid}/applications/{application_uuid}/purchase/{purchase_uuid}/items
Request samples 
application/json
{}
Response samples 
application/json
{
  • "message": "unauthorized"
}
Add Information about Purchase Merchant
POST /v2/shops/:shop_uuid/purchases/:purchase_uuid/merchant


The request adds information about a merchant who provides purchase items within a shop. The request is applicable to shops which act as aggregators.


Note, that even though the parameters in the request body are optional, at least any one of the following parameters is required for successful request processing: merchant_name, merchant_registry_code, merchant_order_reference, merchant_domain_name.


SecuritybearerAuth 
Request 
path Parameters
shop_uuid
required
string
The unique identifier of the shop.


 
 Example:  38571c75-2590-4c81-8252-531613c96363
purchase_uuid
required
string
The unique identifier of a specific purchase.


 
 Example:  1234
Request Body schema: application/json
merchant_name
string
Name of the merchant who is connected to Inbank via an aggregator.


 
merchant_registry_code
string
Merchant's registry code, consisting of eight to eleven digits.


 
merchant_order_reference
string
Order reference of the merchant.


 
merchant_domain_name
string
URL of the merchant.


 
merchant_mcc_code
string
4-digit merchant category code listed in ISO 18245 for retail financial services. This code is used to classify a business by the type of goods or services it provides.


 
Responses 
204
Updated merchant information


401
Unauthorized


403
Forbidden


404
Not Found


422
Unprocessable Entity


500
Internal Server Error


post/partner/v2/shops/{shop_uuid}/purchases/{purchase_uuid}/merchant
Request samples 
application/json
{
  • "purchase_merchant": {
    }
}
Response samples 
application/json
{
  • "message": "unauthorized"
}
Additional Endpoints
Apart from the obligatory workflow, Partner API has the following endpoints which can provide additional possibilities that partners can use for their specific flows.


Product Details
GET /partner/v2/shops/:shop_uuid/products?=product_code


This endpoint can be used before all the steps in the flow for showing the details of the product. The endpoint is applicable both to Redirect Payment integration and Direct API integration.


The product details endpoint retrives product parameters for a given product_code.
The product parameters are set from Inbank's side following the partner's requirements, and the product code thus created is communicated to the partners. Partners can use this product code to GET details on product parameters.


SecuritybearerAuth 
Request 
path Parameters
shop_uuid
required
string
The unique identifier of the shop.


 
 Example:  38571c75-2590-4c81-8252-531613c96363
query Parameters
product_code
string
Code of the Inbank product about which details are required. The product code is provided by Inbank.


 
 Example:  product_code=test_code123
Responses 
200
Return product details by shop UUID & product code


401
Unauthorized


403
Forbidden


404
Not Found


500
Internal Server Error


get/partner/v2/shops/{shop_uuid}/products
Request samples 
Response samples 
application/json
{
  • "code": "product_code_here",
  • "name": "Järelmaks (ePOS downpayment)",
  • "type": "loan",
  • "id": 826,
  • "uuid": "c6ea4dcd-7c08-4e0a-9448-089e85d44142",
  • "parameters": {
    },
  • "subtype": "hire_purchase",
  • "valid_from": "2020-05-04",
  • "valid_to": null
}
Credit Application Submission
POST /partner/v2/shops/:shop_uuid/applications


The example below includes all parameters that can be sent in the POST /application request. Please note, that not all parameters listed below are required. For examples of required parameters for this request, refer to the Direct API Guide.


A credit application can be submitted with minimum dataset capturing mandatory fields, partners have the option to submit a detailed application to capture more information regarding the application itself.


The request payload consists of the following sub-objects:


    

  • credit_application: monthly income, product code and other credit-related data
    • 

  • customer: customer's identity code, name and gender
    • 

  • customer_addresses: customer's address details
    • 

  • customer_contact: customer's email and phone number
    • 

  • customer_identification: the type of customer identification document and its number
    • 

  • purchase: details about the purchased items
    • 

  • consents: customer's consent related to the credit application process.
    • 

  • customer_consents: customer's consent for receiving data
    • 

  • customer_ubos: customer's Ultimate Beneficial Ownership (UBO) information
    • 

  • customer_pep: required details if the customer is PEP (politically exposed person)
    • 

  • customer_self_ubo: whether the customer applying for credit is also the UBO
    • 

  • else_ubo_pep: captures information about individuals who are UBOs of the loan but are not the customers applying themselves and are also identified as PEPs
    • 

  • customer_consent: customer's consent for processing of their individual data
    • 

  • partner_urls: partner/merchant's callback URL
    • 

  • additional_details: additional custom parameters that are related to the credit application.
    • 



SecuritybearerAuth 
Request 
path Parameters
shop_uuid
required
string
The unique identifier of the shop.


 
 Example:  38571c75-2590-4c81-8252-531613c96363
Request Body schema: application/json
required
object
 
object
 
object
 
object
 
object
 
object
 
Array of objects (consents) 
Array of all types of consents related to the credit application process


 
object
 
customer_pep
object
 
object
 
Array of objects (customer_ubos) 
 
Array of objects (consents) 
Array of consents to consents that are directly linked to the customer's individual permissions or agreements with Inbank.


 
object
 
object
 
additional_details
object
Any additional details about the credit application that are not covered with predefined parameters. To be added in key-value pair format.


 
Responses 
201
Create a new application


401
Unauthorized


403
Forbidden


404
Not Found


422
Unprocessable Entity


500
Internal Server Error


post/partner/v2/shops/{shop_uuid}/applications
Request samples 
application/json
{
  • "credit_application": {
    },
  • "customer": {
    },
  • "customer_contact": {
    },
  • "purchase": {
    },
  • "customer_consents": {
    },
  • "customer_ubos": [
    ],
  • "callback_urls": "https://example.com/callback",
  • "customer_addresses": [
    ],
  • "consents": [
    ],
  • "customer_identification": {
    },
  • "customer_consent": [
    ],
  • "customer_pep": {
    },
  • "customer_self_ubo": {
    },
  • "else_ubo_pep": {
    },
  • "partner_urls": {},
  • "additional_details": {
    }
}
Response samples 
application/json
{
  • "uuid": "471e6282-3384-412b-af7b-646eb8f04391",
  • "number": 89002917439,
  • "status": "pending",
  • "product_code": "example_product",
  • "amount": 1001,
  • "period": 12,
  • "down_payment_amount": 0,
  • "payment_day": 15,
  • "start_date": "2020-12-15",
  • "end_date": "2021-11-15",
  • "decision_status": "positive",
  • "decision_messages": "Positive decision",
  • "changed_conditions": false,
  • "previous_uuid": null,
  • "salesperson_reference": "Earl James"
}
Add Payout Account to Contract
POST /partner/v2/shops/:shop_uuid/contracts/:contract_uuid/payout_accounts


The endpoint specifies the account number to which Inbank transfers the required financing amount. Partners can submit a credit application without the
indicated account number, and add it later before the credit contract is activated.


The endpoint applies only to contracts with status either signed or unsigned.
After a credit contract is activated (has status activated), the payout account cannot be added.


SecuritybearerAuth 
Request 
path Parameters
shop_uuid
required
string
The unique identifier of the shop.


 
 Example:  38571c75-2590-4c81-8252-531613c96363
contract_uuid
required
string
The unique identifier of a particular credit contract.


 
 Example:  788ec8c4-c497-470b-8505-2303f151d427
Request Body schema: application/json
payout_bank_account
string
The account to which Inbank is to transfer the financing amount.


 
Responses 
204
Submit payout account to contract


401
Unauthorized


403
Forbidden


404
Not Found


422
Unprocessable Entity


500
Internal Server Error


post/partner/v2/shops/{shop_uuid}/contracts/{contract_uuid}/payout_accounts
Request samples 
application/json
{
  • "payout_bank_account": "PL96109010444793218160811234"
}
Response samples 
application/json
{
  • "message": "unauthorized"
}
Get Payment Schedule of Credit Application
GET /partner/v2/shops/:shop_uuid/applications/:application_uuid/payment_schedules?response_level=full


This endpoint can be used after application has been submitted within the Direct API integration flow.


To retrieve the payment schedule for an application and present it to the customer, the 

GET /partner/v2/shops/:shop_uuid/applications/:application_uuid/payment_schedules?response_level=full request can be used. The level of detail that the response will include, depends on the selected response_level.


SecuritybearerAuth 
Request 
path Parameters
shop_uuid
required
string
The unique identifier of the shop.


 
 Example:  38571c75-2590-4c81-8252-531613c96363
application_uuid
required
string
The unique identifier of a particular credit application.


 
 Example:  471e6282-3384-412b-af7b-646eb8f04391
query Parameters
response_level
required
string
Indication of how detailed the returned response should be. Options: summary, items, full.


 
 Example:  response_level=full
Responses 
200
Get payment schedule


401
Unauthorized


403
Forbidden


404
Not Found


500
Internal Server Error


get/partner/v2/shops/{shop_uuid}/applications/{application_uuid}/payment_schedules
Request samples 
Response samples 
application/json
{
  • "payment_schedule": null,
  • "credit_application_uuid": "11d11011-101b-1e01-1ed1-ca111111f11",
  • "response_level": "full",
  • "period": 1,
  • "amount": "450.0",
  • "payment_day": 10,
  • "down_payment_amount_total": "0.0",
  • "down_payment_amount_prc": null,
  • "net_credit_amount": "450.0",
  • "payment_amount_monthly": "146.25",
  • "interest_rate_annual": "0.0",
  • "contract_fee_amount_total": "135.0",
  • "contract_fee_prc": "0.075",
  • "admin_fee_amount_monthly": "0.0",
  • "admin_fee_amount_total": "0.0",
  • "insurance_fee_amount_monthly": null,
  • "insurance_fee_amount_total": null,
  • "credit_cost_rate_annual": "2.6839",
  • "credit_cost_amount_total": "135.0",
  • "residual_amount_total": null,
  • "residual_amount_prc": null,
  • "interest_type": "floating",
  • "campaign_interest_type": "fixed",
  • "campaign_interest_period_start_date": "2022-03-17",
  • "campaign_interest_period_end_date": "2022-10-10",
  • "campaign_interest_rate": "0.029",
  • "floating_interest_rate": {
    },
  • "interest_bearing_amount": "450.0",
  • "interest_amount_total": "0.0",
  • "repayments_amount_total": "585.0",
  • "first_payment_date": "2019-06-10",
  • "first_payment_amount": "146.25",
  • "last_payment_date": "2019-09-10",
  • "last_payment_amount": "146.25",
  • "payment_schedule_items": [
    ]
}