Skip to content
/Freelancer 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

Create Freelancer Overdraft Application

Request

Creates a freelancer overdraft application and assigns it to the person with the given person_id 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.

Path
person_idstringrequired

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

Bodyapplication/json

The application attributes

partner_risk_classstring

The risk class assigned to a freelancer by the partner.

Example: "d"
partner_reference_numberstring

The partner's reference number.

Example: "a123456"
partner_contact_numberstring

The number of the partner's contact person.

Example: "+491565904345"
partner_contact_namestring

The name of the partner's contact person.

Example: "Peter Mustermann"
credit_record_idstring

The unique ID of a credit record, generated after creating a freelancer credit record.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
application/json
{
  "partner_risk_class": "d",
  "partner_reference_number": "a123456",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a freelancer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of a freelancer overdraft application.

Enum"initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""offered""rejected""expired""deleted""overdraft_created"
Example: "offered"
created_atstring(datetime)required

The date and time the freelancer overdraft application was created.

Example: "2021-08-03T18:01:48.000Z"
rejection_reasonsArray of strings or null

The reason(s) for rejecting an overdraft application.

partner_risk_classstring or null

The risk class assigned to a freelancer by the partner.

Example: "d"
partner_reference_numberstring or null

The partner's reference number.

Example: "a123456"
partner_contact_numberstring or null

The number of the partner's contact person.

Example: "+491565904345"
partner_contact_namestring or null

The name of the partner's contact person.

Example: "Peter Mustermann"
overdraft_ratenumber

The interest rate applicable to the overdraft.

Example: 9
overdraft_idstring or null

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
interest_conditions_enabledboolean
interest_accrual_ratenumber

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

Example: 3
decisionstring or null

Solaris' decision on the overdraft application.

Enum"REJECTED""OFFERED"
Example: "OFFERED"
credit_record_idstring or null

The unique ID of a credit record, generated after creating a freelancer credit record.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
account_snapshot_idstring or null

The unique ID of an account snapshot of a specific person account.

Response
application/json
{
  "status": "offered",
  "rejection_reasons": [
    "string"
  ],
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_risk_class": "d",
  "partner_reference_number": "a123456",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "overdraft_rate": 9,
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_conditions_enabled": true,
  "interest_accrual_rate": 3,
  "id": "b83z264de98741018419b53648e20ca9coap",
  "decision": "OFFERED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_snapshot_id": "string"
}

Get Freelancer Overdraft Application

Request

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

Path
person_idstringrequired

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

overdraft_application_idstringrequired

The unique ID of a freelancer overdraft application.

No request payload

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a freelancer overdraft application.

Example: "b83z264de98741018419b53648e20ca9coap"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of a freelancer overdraft application.

Enum"initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""offered""rejected""expired""deleted""overdraft_created"
Example: "offered"
created_atstring(datetime)required

The date and time the freelancer overdraft application was created.

Example: "2021-08-03T18:01:48.000Z"
rejection_reasonsArray of strings or null

The reason(s) for rejecting an overdraft application.

partner_risk_classstring or null

The risk class assigned to a freelancer by the partner.

Example: "d"
partner_reference_numberstring or null

The partner's reference number.

Example: "a123456"
partner_contact_numberstring or null

The number of the partner's contact person.

Example: "+491565904345"
partner_contact_namestring or null

The name of the partner's contact person.

Example: "Peter Mustermann"
overdraft_ratenumber

The interest rate applicable to the overdraft.

Example: 9
overdraft_idstring or null

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
interest_conditions_enabledboolean
interest_accrual_ratenumber

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

Example: 3
decisionstring or null

Solaris' decision on the overdraft application.

Enum"REJECTED""OFFERED"
Example: "OFFERED"
credit_record_idstring or null

The unique ID of a credit record, generated after creating a freelancer credit record.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
account_snapshot_idstring or null

The unique ID of an account snapshot of a specific person account.

Response
application/json
{
  "status": "offered",
  "rejection_reasons": [
    "string"
  ],
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_risk_class": "d",
  "partner_reference_number": "a123456",
  "partner_contact_number": "+491565904345",
  "partner_contact_name": "Peter Mustermann",
  "overdraft_rate": 9,
  "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_conditions_enabled": true,
  "interest_accrual_rate": 3,
  "id": "b83z264de98741018419b53648e20ca9coap",
  "decision": "OFFERED",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_snapshot_id": "string"
}

Link account snapshot to freelancer overdraft application

Request

Links the account snapshot of the person with the given person_id to their overdraft application. You need to include the account_snapshot_id 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.

Path
person_idstringrequired

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

overdraft_application_idstringrequired

The unique ID of a freelancer overdraft application.

Bodyapplication/json

Account snapshot attributes

account_snapshot_idstringrequired

The unique ID of an account snapshot of a specific person account.

application/json
{
  "account_snapshot_id": "string"
}

Responses

No Content

Response
No content

Create Freelancer Overdraft

Request

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.

Path
person_idstringrequired

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

overdraft_application_idstringrequired

The unique ID of a freelancer overdraft application.

Bodyapplication/json

The application attributes

account_idstringrequired

The unique ID of a customer's bank account.

Example: "575189c6eb825b10b9d0392fcb3bf61dcacc"
application/json
{
  "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}

Responses

Application

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of a created overdraft offered to a freelancer.

Enum"created""interest_conditions_set""limit_set""terminated"
Example: "created"
created_atstring(datetime)required

The date and time the overdraft was created.

Example: "2021-08-03T18:01:48.000Z"
overdraft_ratenumber

The interest rate applicable to the overdraft.

Example: 9
limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
interest_conditions_enabledboolean
interest_accrual_ratenumber

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

Example: 3
account_idstring or null

The unique ID of a customer's bank account.

Example: "575189c6eb825b10b9d0392fcb3bf61dcacc"
Response
application/json
{
  "status": "created",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "overdraft_rate": 9,
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_conditions_enabled": true,
  "interest_accrual_rate": 3,
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}

Get Freelancer Overdraft

Request

Returns all the details of an existing freelancer overdraft, assigned to the person with the given person_id in the path parameter.

Path
person_idstringrequired

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

overdraft_idstringrequired

The unique ID an overdraft, generated after an overdraft is offered.

No request payload

Responses

Application

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of an overdraft offered to a freelancer.

Enum"created""interest_conditions_set""limit_set""terminated"
Example: "created"
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
SolarisToolkit.Web.Money (object)
overdraft_ratenumber

The interest rate applicable to the overdraft.

Example: 9
limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
interest_conditions_enabledboolean
interest_accrual_ratenumber

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

Example: 3
account_idstring or null

The unique ID of a customer's bank account.

Example: "575189c6eb825b10b9d0392fcb3bf61dcacc"
Response
application/json
{
  "status": "created",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "overdraft_rate": 9,
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_conditions_enabled": true,
  "interest_accrued": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 3,
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}

Terminate a freelancer overdraft

Request

Terminates a freelancer overdraft. This operation is only possible if the account balance is positive.

Path
person_idstringrequired

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

overdraft_idstringrequired

The unique ID of a freelancer overdraft.

Bodyapplication/json

The application attributes

object(OverdraftWeb.Freelancer.TerminateOverdraftRequest)
application/json
{}

Responses

Overdraft

Bodyapplication/json
idstringrequired

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

Example: "00556cd181f2409aaa6c2a033cce3a8fcovd"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of an overdraft offered to a freelancer.

Enum"created""interest_conditions_set""limit_set""terminated"
Example: "created"
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
SolarisToolkit.Web.Money (object)
overdraft_ratenumber

The interest rate applicable to the overdraft.

Example: 9
limitobject or null(SolarisToolkit.Web.Money.Optional)
Example: {"value":1000,"unit":"cents","currency":"EUR"}
interest_conditions_enabledboolean
interest_accrual_ratenumber

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

Example: 3
account_idstring or null

The unique ID of a customer's bank account.

Example: "575189c6eb825b10b9d0392fcb3bf61dcacc"
Response
application/json
{
  "status": "created",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "overdraft_rate": 9,
  "limit": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_conditions_enabled": true,
  "interest_accrued": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "interest_accrual_rate": 3,
  "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  "created_at": "2021-08-03T18:01:48.000Z",
  "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}

Consumer Overdrafts

Operations

Consumer Overdrafts Limit Change

Operations

Business Overdrafts

Operations