Overdrafts (1.0)

Download OpenAPI specification:Download

Freelancer Overdrafts

Create Freelancer Overdraft Application

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.

Request
Security:
path Parameters
person_id
required
string

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

Request Body schema: application/json

The application attributes

partner_risk_class
string

The risk class assigned to a freelancer by the partner.

partner_reference_number
string

The partner's reference number.

partner_contact_number
string

The number of the partner's contact person.

partner_contact_name
string

The name of the partner's contact person.

credit_record_id
string

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

Responses
201

Application

400

Invalid request

404

Not Found

post/v1/persons/{person_id}/overdraft_applications
Request samples
application/json
{
  • "partner_risk_class": "d",
  • "partner_reference_number": "a123456",
  • "partner_contact_number": "+491565904345",
  • "partner_contact_name": "Peter Mustermann",
  • "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}
Response samples
application/json
{
  • "status": "offered",
  • "rejection_reasons": [
    ],
  • "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": {
    },
  • "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

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

Request
Security:
path Parameters
person_id
required
string

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

overdraft_application_id
required
string

The unique ID of a freelancer overdraft application.

Responses
200

Application

404

Not Found

get/v1/persons/{person_id}/overdraft_applications/{overdraft_application_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/overdraft_applications/{overdraft_application_id}'
Response samples
application/json
{
  • "status": "offered",
  • "rejection_reasons": [
    ],
  • "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": {
    },
  • "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

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.

Request
Security:
path Parameters
person_id
required
string

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

overdraft_application_id
required
string

The unique ID of a freelancer overdraft application.

Request Body schema: application/json

Account snapshot attributes

account_snapshot_id
required
string

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

Responses
204

No Content

400

Invalid request

404

Not Found

409

Conflict

put/v1/persons/{person_id}/overdraft_applications/{overdraft_application_id}/account_snapshot
Request samples
application/json
{
  • "account_snapshot_id": "string"
}
Response samples
application/json
{
  • "title": "Failed to build pagination headers.",
  • "status": "400",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "detail": "Cannot connect to database.",
  • "code": "build_pagination_headers_failure"
}

Create Freelancer Overdraft

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.

Request
Security:
path Parameters
person_id
required
string

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

overdraft_application_id
required
string

The unique ID of a freelancer overdraft application.

Request Body schema: application/json

The application attributes

account_id
required
string

The unique ID of a customer's bank account.

Responses
201

Application

400

Invalid request

404

Not Found

409

Conflict

put/v1/persons/{person_id}/overdraft_applications/{overdraft_application_id}/overdraft
Request samples
application/json
{
  • "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}
Response samples
application/json
{
  • "status": "created",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "overdraft_rate": 9,
  • "limit": {
    },
  • "interest_conditions_enabled": true,
  • "interest_accrual_rate": 3,
  • "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  • "created_at": "2021-08-03T18:01:48.000Z",
  • "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}

Get Freelancer Overdraft

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

Request
Security:
path Parameters
person_id
required
string

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

overdraft_id
required
string

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

Responses
200

Application

404

Not Found

get/v1/persons/{person_id}/overdrafts/{overdraft_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/overdrafts/{overdraft_id}'
Response samples
application/json
{
  • "status": "created",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "overdraft_rate": 9,
  • "limit": {
    },
  • "interest_conditions_enabled": true,
  • "interest_accrual_rate": 3,
  • "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  • "created_at": "2021-08-03T18:01:48.000Z",
  • "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}

Consumer Overdrafts

Create Consumer Overdraft Application

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

Request
Security:
path Parameters
person_id
required
string

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

Request Body schema: application/json

The application attributes

partner_risk_class
string

The risk class assigned to a customer by the partner.

object or null (SolarisToolkit.Web.Money.Optional)
partner_reference_number
string

The partner's reference number.

partner_contact_number
string

The number of the partner's contact person.

partner_contact_name
string

The name of the partner's contact person.

required
object (SolarisToolkit.Web.Money)
identification_id
required
string

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

employment_status
required
string

The consumer's employment status, mentioned in the signed self-declaration form.

Enum: "EMPLOYED" "UNEMPLOYED" "PUBLIC_SECTOR_EMPLOYEE" "PROFESSIONAL_SOLDIER" "FREELANCER" "HOUSEWORK" "APPRENTICE" "MANAGEMENT" "RETIRED" "STUDENT" "SELF_EMPLOYED" "MILITARY_OR_COMMUNITY_SERVICE"
credit_record_id
required
string

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

account_iban
required
string

The IBAN of a person account.

Responses
201

Application

400

Invalid request

404

Not Found

post/v1/persons/{person_id}/consumer_overdraft_applications
Request samples
application/json
{
  • "partner_risk_class": "d",
  • "partner_requested_limit": {
    },
  • "partner_reference_number": "a123456",
  • "partner_contact_number": "+491565904345",
  • "partner_contact_name": "Peter Mustermann",
  • "net_income_amount": {
    },
  • "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
  • "employment_status": "EMPLOYED",
  • "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  • "account_iban": "DE87110101001000057123"
}
Response samples
application/json
{
  • "status_description": "The overdraft is approved and offered to the customer.",
  • "status": "offered",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "partner_risk_class": "d",
  • "partner_requested_limit": {
    },
  • "partner_reference_number": "a123456",
  • "partner_id": "6ee8e4c8bdc2f9b15870c989706aa9cccpar",
  • "partner_contact_number": "+491565904345",
  • "partner_contact_name": "Peter Mustermann",
  • "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  • "net_income_amount": {
    },
  • "limit": {
    },
  • "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
  • "id": "b83z264de98741018419b53648e20ca9coap",
  • "employment_status": "EMPLOYED",
  • "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  • "created_at": "2021-08-03T18:01:48.000Z",
  • "account_iban": "DE87110101001000057123"
}

Get Consumer Overdraft Application

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

Request
Security:
path Parameters
person_id
required
string

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

overdraft_application_id
required
string

The unique ID of a consumer overdraft application.

Responses
200

Application

403

Forbidden

404

Not Found

get/v1/persons/{person_id}/consumer_overdraft_applications/{overdraft_application_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/consumer_overdraft_applications/{overdraft_application_id}'
Response samples
application/json
{
  • "status_description": "The overdraft is approved and offered to the customer.",
  • "status": "offered",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "partner_risk_class": "d",
  • "partner_requested_limit": {
    },
  • "partner_reference_number": "a123456",
  • "partner_id": "6ee8e4c8bdc2f9b15870c989706aa9cccpar",
  • "partner_contact_number": "+491565904345",
  • "partner_contact_name": "Peter Mustermann",
  • "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  • "net_income_amount": {
    },
  • "limit": {
    },
  • "identification_id": "176a96d1ecf7459d659d1b7f0108a3f2cidt",
  • "id": "b83z264de98741018419b53648e20ca9coap",
  • "employment_status": "EMPLOYED",
  • "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  • "created_at": "2021-08-03T18:01:48.000Z",
  • "account_iban": "DE87110101001000057123"
}

Create Consumer Overdraft

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.

Request
Security:
path Parameters
person_id
required
string

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

overdraft_application_id
required
string

The unique ID of a consumer overdraft application.

Request Body schema: application/json

The application attributes

tnc_accepted_at
required
string <datetime>
account_id
required
string

The unique ID of a person's bank account.

Responses
201

Application

400

Invalid request

404

Not Found

409

Conflict

put/v1/persons/{person_id}/consumer_overdraft_applications/{overdraft_application_id}/overdraft
Request samples
application/json
{
  • "tnc_accepted_at": "2021-08-03T18:01:48.000Z",
  • "account_id": "575189c6eb825b10b9d0392fcb3bf61dcacc"
}
Response samples
application/json
{
  • "status": "created",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "overdraft_rate": 9,
  • "limit": {
    },
  • "interest_accrual_rate": 3,
  • "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  • "created_at": "2021-08-03T18:01:48.000Z",
  • "consumer_application_id": "b83z264de98741018419b53648e20ca9coap",
  • "account_iban": "DE87110101001000057123"
}

Get Consumer Overdraft

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

Request
Security:
path Parameters
person_id
required
string

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

overdraft_id
required
string

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

Responses
200

Overdraft

403

Forbidden

404

Not Found

get/v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/consumer_overdrafts/{overdraft_id}'
Response samples
application/json
{
  • "status": "created",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "overdraft_rate": 9,
  • "limit": {
    },
  • "interest_accrual_rate": 3,
  • "id": "00556cd181f2409aaa6c2a033cce3a8fcovd",
  • "created_at": "2021-08-03T18:01:48.000Z",
  • "consumer_application_id": "b83z264de98741018419b53648e20ca9coap",
  • "account_iban": "DE87110101001000057123"
}

Business Overdrafts

Create Business Overdraft Application

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.

Request
Security:
path Parameters
business_id
required
string

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

Request Body schema: application/json

The application attributes

identification_id
required
string

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

account_iban
required
string

The IBAN of a business account.

Responses
201

Application

400

Invalid request

403

Forbidden

404

Not Found

post/v1/businesses/{business_id}/overdraft_applications
Request samples
application/json
{
  • "identification_id": "1bb49f9dec3a57ae69ad3c3183316c9dcidt",
  • "account_iban": "DE13110101014386274299"
}
Response samples
application/json
{
  • "status": "scoring_pending",
  • "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fbovd",
  • "limit_increase_rejection_reason": "string",
  • "initial_overdraft_limit": {
    },
  • "identification_id": "1bb49f9dec3a57ae69ad3c3183316c9dcidt",
  • "id": "fdsdefghijklmnopqrstuvwxyz012346boap",
  • "final_overdraft_limit": {
    },
  • "created_at": "2021-08-03T18:01:48.000Z",
  • "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  • "account_iban": "DE13110101014386274299"
}

Get Business Overdraft Application

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

Request
Security:
path Parameters
business_id
required
string

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

overdraft_application_id
required
string

The unique ID of a business overdraft application.

Responses
200

Application

403

Forbidden

404

Not Found

get/v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}'
Response samples
application/json
{
  • "status": "scoring_pending",
  • "overdraft_id": "00556cd181f2409aaa6c2a033cce3a8fbovd",
  • "limit_increase_rejection_reason": "string",
  • "initial_overdraft_limit": {
    },
  • "identification_id": "1bb49f9dec3a57ae69ad3c3183316c9dcidt",
  • "id": "fdsdefghijklmnopqrstuvwxyz012346boap",
  • "final_overdraft_limit": {
    },
  • "created_at": "2021-08-03T18:01:48.000Z",
  • "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  • "account_iban": "DE13110101014386274299"
}

Increase limit in Business Overdraft Application

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.

Request
Security:
path Parameters
business_id
required
string

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

overdraft_application_id
required
string

The unique ID of the business overdraft application.

Responses
204

No Content

400

Invalid request

403

Forbidden

409

Conflict

post/v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}/limit_increase
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}/limit_increase'
Response samples
application/json
{
  • "title": "Failed to build pagination headers.",
  • "status": "400",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "detail": "Cannot connect to database.",
  • "code": "build_pagination_headers_failure"
}

Confirm Business Overdraft Application

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.

Request
Security:
path Parameters
business_id
required
string

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

overdraft_application_id
required
string

The unique ID of the business overdraft application.

Responses
204

No Content

403

Forbidden

404

Not Found

409

Conflict

post/v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}/confirm
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}/confirm'
Response samples
application/json
{
  • "title": "Unauthorized Action",
  • "status": "403",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "detail": "Unauthorized action is not allowed.",
  • "code": "unauthorized_action"
}

Cancel Business Overdraft Application

Cancels an existing business overdraft application.

Request
Security:
path Parameters
business_id
required
string

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

overdraft_application_id
required
string

The unique ID of a business overdraft application.

Responses
204

No Content

403

Forbidden

404

Not Found

409

Conflict

post/v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}/cancel
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/overdraft_applications/{overdraft_application_id}/cancel'
Response samples
application/json
{
  • "title": "Unauthorized Action",
  • "status": "403",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "detail": "Unauthorized action is not allowed.",
  • "code": "unauthorized_action"
}

Get Business Overdraft

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

Request
Security:
path Parameters
business_id
required
string

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

overdraft_id
required
string

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

Responses
200

Overdraft

403

Forbidden

404

Not Found

get/v1/businesses/{business_id}/overdrafts/{overdraft_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/overdrafts/{overdraft_id}'
Response samples
application/json
{
  • "status": "created",
  • "overdraft_rate": 8,
  • "limit": {
    },
  • "interest_accrual_rate": 3,
  • "id": "00556cd181f2409aaa6c2a033cce3a8fbovd",
  • "created_at": "2021-08-03T18:01:48.000Z",
  • "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  • "application_id": "fdsdefghijklmnopqrstuvwxyz012346boap",
  • "account_iban": "DE13110101014386274299"
}