# 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 [<b>Merchant Withdrawal section</b>](/api/full-api-flow/#operation/postMerchantWithdrawal) and on partial returns in the [<b>Partial Returns Guide</b>](/api/partial-return-flow/#section/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 [<b>ePOS Short Flow Guide</b>](/api/epos-short-flow/#section/Introduction).

# Documentation Archive

Here you can find links to our archived integration guides using the v2 endpoints:

[<b>Archived Redirect Payment Guide</b>](/api/epos-flow-archived/#section/Redirect-Payment-Guide)

[<b>Archived Short Flow Guide</b>](/api/epos-short-flow-archived/#section/Introduction)

[<b>Archived Direct Integration Guides</b>](/api/overview-full-api-flow-archived/#section/Direct-API-Guide)

[<b>Archived Smart Rent Guide</b>](/api/smart-rent-flow-archived/#section/Integration-Guide-for-Inbank-Smart-Rent)



## Servers

Demo environment
```
https://demo-api.inbank.ee
```

Live environment
```
https://api.inbank.ee
```

## Security

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[Additional Resources](https://docs.inbank.eu/_bundle/api/additional-api-flow.yaml)

## Purchase Related Endpoints

The endpoints under this section relate to the purchase information sent to Inbank in connection with a credit application. These endpoints are part of the [Direct API flow](/api/overview-full-api-flow/#section/Direct-API-Guide) and can be used after the credit application has been submitted.

### Add or Update Application Purchase

 - [PUT /partner/v2/shops/{shop_uuid}/applications/{application_uuid}/purchase/{purchase_uuid}](https://docs.inbank.eu/api/additional-api-flow/purchase-related-endpoints/putpurchase.md): 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.

### Update Application Purchase Items

 - [PUT /partner/v2/shops/{shop_uuid}/applications/{application_uuid}/purchase/{purchase_uuid}/items](https://docs.inbank.eu/api/additional-api-flow/purchase-related-endpoints/putpurchaseitems.md): 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.

### Add Information about Purchase Merchant

 - [POST /partner/v2/shops/{shop_uuid}/purchases/{purchase_uuid}/merchant](https://docs.inbank.eu/api/additional-api-flow/purchase-related-endpoints/postmerchant.md): 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.

## 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](https://docs.inbank.eu/api/additional-api-flow/additional-endpoints/getproducts.md): 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.

### Credit Application Submission

 - [POST /partner/v2/shops/{shop_uuid}/applications](https://docs.inbank.eu/api/additional-api-flow/additional-endpoints/postapplications.md): 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.

### Add Payout Account to Contract

 - [POST /partner/v2/shops/{shop_uuid}/contracts/{contract_uuid}/payout_accounts](https://docs.inbank.eu/api/additional-api-flow/additional-endpoints/postpayoutaccounts.md): 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.

### Get Payment Schedule of Credit Application

 - [GET /partner/v2/shops/{shop_uuid}/applications/{application_uuid}/payment_schedules](https://docs.inbank.eu/api/additional-api-flow/additional-endpoints/getpaymentschedules.md): 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.