Skip to content
/Business Overdrafts

Overdrafts (1.0)

Download OpenAPI description
overdrafts.json
overdrafts.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/lending/overdrafts/

Freelancer Overdrafts

Operations

Consumer Overdrafts

Operations

Consumer Overdrafts Limit Change

Operations

Business Overdrafts

Operations

Create Business Overdraft Application

Request

Creates a business overdraft application and assigns it to the business with the given business_id in the path parameter. You have to include the identification_id and the account_iban 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.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

Bodyapplication/json

The application attributes

identification_idstringrequired

The unique identification ID of a business, generated after completing the business identification process.

Example: "1bb49f9dec3a57ae69ad3c3183316c9dcidt"
account_ibanstringrequired

The IBAN of a business account.

Example: "DE13110101014386274299"
application/json
{
  "identification_id": "1bb49f9dec3a57ae69ad3c3183316c9dcidt",
  "account_iban": "DE13110101014386274299"
}

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a business overdraft application.

Example: "fdsdefghijklmnopqrstuvwxyz012346boap"
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
identification_idstringrequired

The unique identification ID of a business, generated after completing the business identification process.

Example: "1bb49f9dec3a57ae69ad3c3183316c9dcidt"
account_ibanstringrequired

The IBAN of a business account.

Example: "DE13110101014386274299"
statusstringrequired

The status of a business overdraft application.

Enum"scoring_pending""offered""rejected""canceled""confirmed""limit_increase_decision_pending""information_required"
Example: "scoring_pending"
created_atstring(datetime)required

The date and time the business overdraft application was created.

Example: "2021-08-03T18:01:48.000Z"
overdraft_idstring or null

The unique ID of a business overdraft, generated after an overdraft is offered.

Example: "00556cd181f2409aaa6c2a033cce3a8fbovd"
limit_increase_rejection_reasonstring or null

The reason(s) for rejecting a limit increase request.

initial_overdraft_limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
final_overdraft_limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
Response
application/json
{
  "status": "scoring_pending",
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fbovd",
  "limit_increase_rejection_reason": "string",
  "initial_overdraft_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "identification_id": "1bb49f9dec3a57ae69ad3c3183316c9dcidt",
  "id": "fdsdefghijklmnopqrstuvwxyz012346boap",
  "final_overdraft_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "created_at": "2021-08-03T18:01:48.000Z",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "account_iban": "DE13110101014386274299"
}

Get Business Overdraft Application

Request

Returns the status and details of an existing business overdraft application.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

overdraft_application_idstringrequired

The unique ID of a business overdraft application.

No request payload

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a business overdraft application.

Example: "fdsdefghijklmnopqrstuvwxyz012346boap"
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
identification_idstringrequired

The unique identification ID of a business, generated after completing the business identification process.

Example: "1bb49f9dec3a57ae69ad3c3183316c9dcidt"
account_ibanstringrequired

The IBAN of a business account.

Example: "DE13110101014386274299"
statusstringrequired

The status of a business overdraft application.

Enum"scoring_pending""offered""rejected""canceled""confirmed""limit_increase_decision_pending""information_required"
Example: "scoring_pending"
created_atstring(datetime)required

The date and time the business overdraft application was created.

Example: "2021-08-03T18:01:48.000Z"
overdraft_idstring or null

The unique ID of a business overdraft, generated after an overdraft is offered.

Example: "00556cd181f2409aaa6c2a033cce3a8fbovd"
limit_increase_rejection_reasonstring or null

The reason(s) for rejecting a limit increase request.

initial_overdraft_limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
final_overdraft_limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
Response
application/json
{
  "status": "scoring_pending",
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fbovd",
  "limit_increase_rejection_reason": "string",
  "initial_overdraft_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "identification_id": "1bb49f9dec3a57ae69ad3c3183316c9dcidt",
  "id": "fdsdefghijklmnopqrstuvwxyz012346boap",
  "final_overdraft_limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "created_at": "2021-08-03T18:01:48.000Z",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "account_iban": "DE13110101014386274299"
}

Increase limit in Business Overdraft Application

Request

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.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

overdraft_application_idstringrequired

The unique ID of the business overdraft application.

No request payload

Responses

No Content

Response
No content

Confirm Business Overdraft Application

Request

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.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

overdraft_application_idstringrequired

The unique ID of the business overdraft application.

No request payload

Responses

No Content

Response
No content

Cancel Business Overdraft Application

Request

Cancels an existing business overdraft application.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

overdraft_application_idstringrequired

The unique ID of a business overdraft application.

No request payload

Responses

No Content

Response
No content

Get Business Overdraft

Request

Returns all the details of an existing business overdraft, assigned to the business with the given business_id.

Path
business_idstringrequired

The unique business ID, generated after completing the business onboarding process.

overdraft_idstringrequired

The unique ID of a business overdraft, generated after an overdraft is offered.

No request payload

Responses

Overdraft

Bodyapplication/json
idstringrequired

The unique ID of a business overdraft, generated after an overdraft is offered.

Example: "00556cd181f2409aaa6c2a033cce3a8fbovd"
business_idstringrequired

The unique ID of a business, generated after completing the business onboarding process.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
application_idstringrequired

The unique ID of a business overdraft application.

Example: "fdsdefghijklmnopqrstuvwxyz012346boap"
account_ibanstringrequired

The IBAN of a business account.

Example: "DE13110101014386274299"
statusstringrequired

The status of a business overdraft.

Enum"created""conditions_pending""limit_pending""attached""terminated"
Example: "created"
interest_accrual_ratenumber(float)required

The daily rate at which interest is accrued on the used amount of an overdraft.

Example: 3
overdraft_ratenumber(float)required

The interest rate applicable to the overdraft.

Example: 8
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
interest_accruedSolarisToolkit.Web.Money (object)required

The daily interest accrued by a business account.

SolarisToolkit.Web.Money (object)

The daily interest accrued by a business account.

limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
Response
application/json
{
  "status": "created",
  "overdraft_rate": 8,
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrued": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 3,
  "id": "00556cd181f2409aaa6c2a033cce3a8fbovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "application_id": "fdsdefghijklmnopqrstuvwxyz012346boap",
  "account_iban": "DE13110101014386274299"
}