# Overdrafts Version: 1.0 ## Servers Sandbox ``` https://api.solaris-sandbox.de ``` Production ``` https://api.solarisbank.de ``` ## Download OpenAPI description [Overdrafts](https://docs.solarisgroup.com/_spec/api-reference/lending/overdrafts.yaml) ## Freelancer Overdrafts ### Create Freelancer Overdraft Application - [POST /v1/persons/{person_id}/overdraft_applications](https://docs.solarisgroup.com/api-reference/lending/overdrafts/freelancer-overdrafts/overdraftweb.v1.freelancer.applications.createoperation.md): Creates a freelancer overdraft application and assigns it to the with the given in the path parameter. Before calling this endpoint, you need to create a credit record for the customer and include it in the payload. Afterwards, Solaris' credit scoring system assesses the application to determine the person credit eligibility and either approves or rejects the application. ### Get Freelancer Overdraft Application - [GET /v1/persons/{person_id}/overdraft_applications/{overdraft_application_id}](https://docs.solarisgroup.com/api-reference/lending/overdrafts/freelancer-overdrafts/overdraftweb.v1.freelancer.applications.showoperation.md): Returns the status and details of an existing freelancer overdraft application. ### Link account snapshot to freelancer overdraft application - [PUT /v1/persons/{person_id}/overdraft_applications/{overdraft_application_id}/account_snapshot](https://docs.solarisgroup.com/api-reference/lending/overdrafts/freelancer-overdrafts/overdraftweb.v1.freelancer.applications.linkaccountsnapshotoperation.md): Links the account snapshot of the with the given to their overdraft application. You need to include the in the payload. Solaris' credit scoring system uses the account snapshot to retrieve the customer's account information, balance, and transaction history to assess their credit eligibility. ### Create Freelancer Overdraft - [PUT /v1/persons/{person_id}/overdraft_applications/{overdraft_application_id}/overdraft](https://docs.solarisgroup.com/api-reference/lending/overdrafts/freelancer-overdrafts/overdraftweb.v1.freelancer.overdrafts.createoperation.md): Creates a freelancer overdraft and activates the offered overdraft limit in the customer's account. After Solaris approves the overdraft application, you have to call this endpoint to create and activate the overdraft. ### Get Freelancer Overdraft - [GET /v1/persons@{person_id}/overdrafts/{overdraft_id}](https://docs.solarisgroup.com/api-reference/lending/overdrafts/freelancer-overdrafts/overdraftweb.v1.freelancer.overdrafts.showoperation.md): Returns all the details of an existing freelancer overdraft, assigned to the with the given in the path parameter. ### Terminate a freelancer overdraft - [POST /v1/persons/{person_id}/overdrafts/{overdraft_id}/terminate](https://docs.solarisgroup.com/api-reference/lending/overdrafts/freelancer-overdrafts/overdraftweb.v1.freelancer.overdrafts.terminateoperation.md): Terminates a freelancer overdraft. This operation is only possible if the account balance is positive. ## Consumer Overdrafts ### Create Consumer Overdraft Application - [POST /v1/persons/{person_id}/consumer_overdraft_applications](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.consumer.applications.createoperation.md): Creates a consumer overdraft application and assigns it to the with the given in the path parameter. Before calling this endpoint, you must collect the required information from the customer, such as the employment status and income declaration and the consent to the account snapshot and credit check. Additionally, you need to create a credit record for the customer. Afterwards, Solaris' credit scoring system assesses the application to determine the person credit eligibility and either approves or rejects the application. ### Get Consumer Overdraft Application - [GET /v1/persons/{person_id}/consumer_overdraft_applications/{overdraft_application_id}](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.consumer.applications.showoperation.md): Returns the status and details of an existing consumer overdraft application. ### List Consumer Overdraft Applications - [GET /v1/persons/consumer_overdraft_applications](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.consumer.applications.indexoperation.md) ### Download the pre-contractual information for consumer overdraft - [GET /v1/persons/{person_id}/consumer_overdraft_applications/{application_id}/pre_contract](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.applications.downloadprecontractoperation.md): Generates a SECCI form, which is the overview of the final offer and the contract. This endpoint downloads the SECCI form as a PDF, which you must share with the customer to review the data based on which the final contract is generated. ### Download the conditions form information for consumer overdraft - [GET /v1/persons/{person_id}/consumer_overdraft_applications/{application_id}/conditions](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.applications.downloadconditionsoperation.md): Generates a conditions form, which is the overview of all conditions. This is an unsigned document and essentially replaces the contract document for overdrafts. ### Create Consumer Overdraft - [PUT /v1/persons/{person_id}/consumer_overdraft_applications/{overdraft_application_id}/overdraft](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.consumer.overdrafts.createoperation.md): Creates a consumer overdraft and activates the offered overdraft limit in the customer's account. After Solaris approves a consumer overdraft application, you have to call this endpoint and the overdraft amount will be set as an external limit to the customer's account. ### Get Consumer Overdraft - [GET /v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.consumer.overdrafts.showoperation.md): Returns all the details of an existing consumer overdraft, assigned to the with the given in the path parameter. ### List Consumer Overdrafts - [GET /v1/persons/consumer_overdrafts](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.consumer.overdrafts.indexoperation.md): This endpoint returns a list containing all consumer overdrafts for all of your customers. ### Download the pre-contractual information for consumer overdraft limit increase - [GET /v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}/limit_changes/{limit_change_id}/pre_contract](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.consumer.limitchanges.downloadprecontractoperation.md): Generates a SECCI form for limit increase request, which is the overview of the final offer and the contract. This endpoint downloads the SECCI form as a PDF, which you must share with the customer to review the data based on which the final contract is generated. ### Download the conditions form information for consumer overdraft limit increase - [GET /v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}/limit_changes/{limit_change_id}/conditions](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.consumer.limitchanges.downloadconditionsoperation.md): Generates a conditions form for limit increase request, which is the overview of all conditions. This is an unsigned document and essentially replaces the contract document for overdrafts. ### Terminate a Consumer Overdraft - [POST /v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}/terminate](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts/overdraftweb.v1.consumer.overdrafts.terminateoperation.md): Terminates a consumer overdraft. This operation is only possible if the account balance is or after booking the accrued interest from the overdraft usage on the account. ## Consumer Overdrafts Limit Change ### Update Limit Change - [PUT /v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}/limit_changes/{limit_change_id}](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts-limit-change/overdraftweb.v1.consumer.limitchanges.putoperation.md): Updates the limit change and activates the requested overdraft limit in the customer's account. After Solaris approves a consumer limit change, you have to call this endpoint and the requested amount will be set as an external limit to the customer's account. ### Show Consumer Overdraft Limit Change - [GET /v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}/limit_changes/{limit_change_id}](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts-limit-change/overdraftweb.v1.consumer.limitchanges.showoperation.md): Shows a consumer overdraft limit change. ### Create Consumer Overdraft Limit Change - [POST /v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}/limit_changes](https://docs.solarisgroup.com/api-reference/lending/overdrafts/consumer-overdrafts-limit-change/overdraftweb.v1.consumer.limitchanges.createoperation.md): Creates a consumer overdraft limit change. ## Business Overdrafts ### Create Business Overdraft Application - [POST /v1/businesses/{business_id}/overdraft_applications](https://docs.solarisgroup.com/api-reference/lending/overdrafts/business-overdrafts/overdraftweb.v1.business.applications.createoperation.md): Creates a business overdraft application and assigns it to the with the given in the path parameter. You have to include the and the of the business in the payload. Afterwards, Solaris' credit scoring system assesses the application to determine the business credit eligibility and either approves or rejects the application. ### Get Business Overdraft Application - [GET /v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}](https://docs.solarisgroup.com/api-reference/lending/overdrafts/business-overdrafts/overdraftweb.v1.business.applications.showoperation.md): Returns the status and details of an existing business overdraft application. ### Increase limit in Business Overdraft Application - [POST /v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}/limit_increase](https://docs.solarisgroup.com/api-reference/lending/overdrafts/business-overdrafts/overdraftweb.v1.business.applications.limitincreaseoperation.md): Requests a limit increase for an approved or confirmed business overdraft application. After Solaris approves an overdraft application, the business receives an offer with an initial overdraft limit and can either confirm the offer or request a limit increase by calling this endpoint. A limit increase request is subject to an additional credit check by Solaris and can be approved or rejected. ### Confirm Business Overdraft Application - [POST /v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}/confirm](https://docs.solarisgroup.com/api-reference/lending/overdrafts/business-overdrafts/overdraftweb.v1.business.applications.confirmoperation.md): Confirms a business overdraft application and activates the overdraft limit. Once Solaris approves a business overdraft application, you must confirm the overdraft by calling this endpoint. Afterwards, the overdraft amount will be credited to the business account. You have to call this enpoint also after receiving an approval on a limit increase request. ### Cancel Business Overdraft Application - [POST /v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}/cancel](https://docs.solarisgroup.com/api-reference/lending/overdrafts/business-overdrafts/overdraftweb.v1.business.applications.canceloperation.md): Cancels an existing business overdraft application. ### Get Business Overdraft - [GET /v1/businesses/{business_id}/overdrafts/{overdraft_id}](https://docs.solarisgroup.com/api-reference/lending/overdrafts/business-overdrafts/overdraftweb.v1.business.overdrafts.showoperation.md): Returns all the details of an existing business overdraft, assigned to the with the given .