Skip to content
Splitpay
/
/
Calculate anonymous insta...

Splitpay (1.0)

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

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

Consumer Credit Line

Operations

Credit Line Servicing

Operations

Freelancer Credit Line

Operations

Calculate anonymous installment plans for a given amount

Request

Generates an anonymous credit line installment plan for a specific amount, including the monthly installment amount, the loan duration, and the applicable interest rates, allowing potential customers to receive an initial offer before applying for a credit line.

Bodyapplication/json

Anonymous installment plans params

amountobjectrequired
Example: {"currency":"EUR","unit":"cents","value":100000}
amount.​valueinteger>= 1required

The amount value

Example: 100000
amount.​currencystringrequired

The currency of the given value

Example: "EUR"
amount.​unitstringrequired

The unit of the given value

Value"cents"
Example: "cents"
interest_ratenumber or null(float)

The interest rate applicable on the credit line. This rate is fixed for each partner depending on contractual and commercial agreements with Solaris.

Example: 1
loan_typestring or null

Loan type which defines partner's product category

Default "installment_plan"
Enum"installment_plan""bullet"
application/json
{
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 100000
  },
  "interest_rate": 1,
  "loan_type": "installment_plan"
}

Responses

Anonymous Installment Plans

Bodyapplication/json
installment_plansArray of objects(FreelancerCreditLineWeb.CreditLines.InstallmentPlans.Item)required
installment_plans[].​termintegerrequired

The duration of the installment loan.

Example: 3
installment_plans[].​monthly_installmentobject(SolarisToolkit.Web.Money)required

The monthly installment amount.

Example: {"currency":"EUR","unit":"cents","value":1000}
installment_plans[].​monthly_installment.​valueintegerrequired

The amount value

Example: 1000
installment_plans[].​monthly_installment.​currencystringrequired

The currency of the given value. Only EURO is currently supported.

Example: "EUR"
installment_plans[].​monthly_installment.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
installment_plans[].​totalobject(SolarisToolkit.Web.Money)required

The total amount due.

Example: {"currency":"EUR","unit":"cents","value":1000}
installment_plans[].​total.​valueintegerrequired

The amount value

Example: 1000
installment_plans[].​total.​currencystringrequired

The currency of the given value. Only EURO is currently supported.

Example: "EUR"
installment_plans[].​total.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
installment_plans[].​interest_ratenumberrequired

The interest rate applicable on the credit line. This rate is fixed for each partner depending on contractual and commercial agreements with Solaris.

Example: 1
installment_plans[].​effective_interest_ratenumberrequired

The effective interest rate on the credit line charged monthly.

Example: 3
Response
application/json
{
  "installment_plans": [
    { … }
  ]
}

Create freelancer credit line application

Request

Creates a freelancer credit line application. The payload of this endpoint includes all the required financial information and account data about the customer, which the credit scorer uses to initiate a series of credit checks to determine the customer's credit risk and eligibility.

Path
person_idstringrequired

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

Bodyapplication/json

The application attributes

recipient_ibanstringrequired

The IBAN of the beneficiary's account.

Example: "DE13110101014386274299"
annual_turnoverobject(SolarisToolkit.Web.Money)required

The total annual income generated by the freelancer's business before deducting any expenses.

Example: {"currency":"EUR","unit":"cents","value":1000}
annual_turnover.​valueintegerrequired

The amount value

Example: 1000
annual_turnover.​currencystringrequired

The currency of the given value. Only EURO is currently supported.

Example: "EUR"
annual_turnover.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
monthly_net_profitobject(SolarisToolkit.Web.Money)required

The monthly net profit generated by the freelancer's business after deducting all recurring business expenses.

Example: {"currency":"EUR","unit":"cents","value":1000}
monthly_net_profit.​valueintegerrequired

The amount value

Example: 1000
monthly_net_profit.​currencystringrequired

The currency of the given value. Only EURO is currently supported.

Example: "EUR"
monthly_net_profit.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
monthly_private_fixed_costobject(SolarisToolkit.Web.Money)required

The total monthly amount of private fixed costs for the freelancer. Private costs include expenses not related to the business activities, such as rent or health insurance.

Example: {"currency":"EUR","unit":"cents","value":1000}
monthly_private_fixed_cost.​valueintegerrequired

The amount value

Example: 1000
monthly_private_fixed_cost.​currencystringrequired

The currency of the given value. Only EURO is currently supported.

Example: "EUR"
monthly_private_fixed_cost.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
monthly_non_mortgage_credit_expenseobject(SolarisToolkit.Web.Money)required

The total monthly amount of credit expenses incurred by the freelancer, excluding mortgage-related expenses.

Example: {"currency":"EUR","unit":"cents","value":1000}
monthly_non_mortgage_credit_expense.​valueintegerrequired

The amount value

Example: 1000
monthly_non_mortgage_credit_expense.​currencystringrequired

The currency of the given value. Only EURO is currently supported.

Example: "EUR"
monthly_non_mortgage_credit_expense.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
legal_formstringrequired

The legal form of the freelancer's business.

Enum"FREE_OCCUPATION""COMMERCIAL_ENTERPRISE""OTHER"
Example: "FREE_OCCUPATION"
foundation_datestring(date)required

The date on which the freelancer's business was founded.

Example: "2019-08-24"
corporate_namestringrequired

The corporate name of the freelancer's business.

tax_idstringrequired

The tax ID associated with the freelancer's legal entity.

Example: "3012034567890"
pre_selected_by_partnerboolean

Value to be set when customer is pre selected by own risk assessment.

Default false
application/json
{
  "annual_turnover": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "corporate_name": "string",
  "foundation_date": "2019-08-24",
  "legal_form": "FREE_OCCUPATION",
  "monthly_net_profit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "monthly_non_mortgage_credit_expense": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "monthly_private_fixed_cost": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "pre_selected_by_partner": false,
  "recipient_iban": "DE13110101014386274299",
  "tax_id": "3012034567890"
}

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a freelancer credit line application.

Example: "7d903b7483294e3b902b89097d699dbdccla"
decisionstringrequired

Solaris' decision on the credit line request.

Enum"OFFERED""PENDING""REJECTED"
Example: "REJECTED"
statusstringrequired

The status of the credit line application.

Enum"credit_record_pending""initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""offered""identification_creation_pending""identification_pending""identification_completed""rejected""expired"
Example: "rejected"
credit_line_idstring or null

The unique ID of a credit line.

Example: "c5f22b00baa845869ceb3a7d90d59bffccln"
identification_idstring or null

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

Example: "51462340e8653f8e2864801e8ebb4131cidt"
mandate_reference_numberstring or null

The reference number of the mandate applicable on the credit line.

Example: "LXD3RGLRTP6HHM"
net_disposable_incomeobject or null(SolarisToolkit.Web.Money.Optional)

The net disposable income amount available after deducting taxes and all other expenses.

Example: {"currency":"EUR","unit":"cents","value":1000}
offered_interest_ratenumber or null

Solaris' offered interest rate on the installment loan.

Example: 0.11
offered_limitobject or null(SolarisToolkit.Web.Money.Optional)

The amount of the credit line limit offered to the freelancer.

Example: {"currency":"EUR","unit":"cents","value":1000}
person_idstring

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

Example: "ad8f5cefdc73035f17973fecb4fa2ebccper"
reasonstring or null

Solaris' decision on the credit line request.

recipient_ibanstring or null

The IBAN of the beneficiary's account.

Example: "DE13110101014386274299"
status_descriptionstring or null

The description of the credit line application's status.

Example: "Rejected by Scorer"
Response
application/json
{
  "credit_line_id": "c5f22b00baa845869ceb3a7d90d59bffccln",
  "decision": "REJECTED",
  "id": "7d903b7483294e3b902b89097d699dbdccla",
  "identification_id": "51462340e8653f8e2864801e8ebb4131cidt",
  "mandate_reference_number": "LXD3RGLRTP6HHM",
  "net_disposable_income": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "offered_interest_rate": 0.11,
  "offered_limit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
  "reason": "string",
  "recipient_iban": "DE13110101014386274299",
  "status": "rejected",
  "status_description": "Rejected by Scorer"
}

Retrieve freelancer credit line application

Request

Returns the current status and details of an existing freelancer credit line application.

Path
person_idstringrequired

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

application_idstringrequired

Freelancer Credit Line Application ID

No request payload

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a freelancer credit line application.

Example: "7d903b7483294e3b902b89097d699dbdccla"
decisionstringrequired

Solaris' decision on the credit line request.

Enum"OFFERED""PENDING""REJECTED"
Example: "REJECTED"
statusstringrequired

The status of the credit line application.

Enum"credit_record_pending""initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""offered""identification_creation_pending""identification_pending""identification_completed""rejected""expired"
Example: "rejected"
credit_line_idstring or null

The unique ID of a credit line.

Example: "c5f22b00baa845869ceb3a7d90d59bffccln"
identification_idstring or null

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

Example: "51462340e8653f8e2864801e8ebb4131cidt"
mandate_reference_numberstring or null

The reference number of the mandate applicable on the credit line.

Example: "LXD3RGLRTP6HHM"
net_disposable_incomeobject or null(SolarisToolkit.Web.Money.Optional)

The net disposable income amount available after deducting taxes and all other expenses.

Example: {"currency":"EUR","unit":"cents","value":1000}
offered_interest_ratenumber or null

Solaris' offered interest rate on the installment loan.

Example: 0.11
offered_limitobject or null(SolarisToolkit.Web.Money.Optional)

The amount of the credit line limit offered to the freelancer.

Example: {"currency":"EUR","unit":"cents","value":1000}
person_idstring

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

Example: "ad8f5cefdc73035f17973fecb4fa2ebccper"
reasonstring or null

Solaris' decision on the credit line request.

recipient_ibanstring or null

The IBAN of the beneficiary's account.

Example: "DE13110101014386274299"
status_descriptionstring or null

The description of the credit line application's status.

Example: "Rejected by Scorer"
Response
application/json
{
  "credit_line_id": "c5f22b00baa845869ceb3a7d90d59bffccln",
  "decision": "REJECTED",
  "id": "7d903b7483294e3b902b89097d699dbdccla",
  "identification_id": "51462340e8653f8e2864801e8ebb4131cidt",
  "mandate_reference_number": "LXD3RGLRTP6HHM",
  "net_disposable_income": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "offered_interest_rate": 0.11,
  "offered_limit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
  "reason": "string",
  "recipient_iban": "DE13110101014386274299",
  "status": "rejected",
  "status_description": "Rejected by Scorer"
}

Link credit record to freelancer credit line application

Request

Links a freelancer credit record to their existing credit line application. You have to add the unique ID of the credit record in the payload of this endpoint.

Path
person_idstringrequired

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

application_idstringrequired

The unique ID of a freelancer credit line application.

Bodyapplication/json

Credit Record link

credit_record_idstringrequired

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

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
application/json
{
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}

Responses

No Content

Response
No content

Link account snapshot to freelancer credit line application

Request

Links a freelancer account snapshot to their existing credit line application. You have to add the unique ID of the account snapshot in the payload of this endpoint.

Path
person_idstringrequired

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

application_idstringrequired

The unique ID of a freelancer credit line application.

Bodyapplication/json

Account snapshot link

account_snapshot_idstringrequired

The unique ID of a customer account snapshot.

Example: "0a3f28733f9a4842842aae2804f80eb4snap"
application/json
{
  "account_snapshot_id": "0a3f28733f9a4842842aae2804f80eb4snap"
}

Responses

No Content

Response
No content

Set contract agreement date for a freelancer credit line application

Request

Creates the credit line contract agreement. After a credit application passes the credit checks, call this endpoint and collect the customer's consent on the credit line contract and terms and conditions.

Path
person_idstringrequired

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

application_idstringrequired

The unique ID of a freelancer credit line application.

No request payload

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a freelancer credit line application.

Example: "7d903b7483294e3b902b89097d699dbdccla"
decisionstringrequired

Solaris' decision on the credit line request.

Enum"OFFERED""PENDING""REJECTED"
Example: "REJECTED"
statusstringrequired

The status of the credit line application.

Enum"credit_record_pending""initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""offered""identification_creation_pending""identification_pending""identification_completed""rejected""expired"
Example: "rejected"
credit_line_idstring or null

The unique ID of a credit line.

Example: "c5f22b00baa845869ceb3a7d90d59bffccln"
identification_idstring or null

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

Example: "51462340e8653f8e2864801e8ebb4131cidt"
mandate_reference_numberstring or null

The reference number of the mandate applicable on the credit line.

Example: "LXD3RGLRTP6HHM"
net_disposable_incomeobject or null(SolarisToolkit.Web.Money.Optional)

The net disposable income amount available after deducting taxes and all other expenses.

Example: {"currency":"EUR","unit":"cents","value":1000}
offered_interest_ratenumber or null

Solaris' offered interest rate on the installment loan.

Example: 0.11
offered_limitobject or null(SolarisToolkit.Web.Money.Optional)

The amount of the credit line limit offered to the freelancer.

Example: {"currency":"EUR","unit":"cents","value":1000}
person_idstring

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

Example: "ad8f5cefdc73035f17973fecb4fa2ebccper"
reasonstring or null

Solaris' decision on the credit line request.

recipient_ibanstring or null

The IBAN of the beneficiary's account.

Example: "DE13110101014386274299"
status_descriptionstring or null

The description of the credit line application's status.

Example: "Rejected by Scorer"
Response
application/json
{
  "credit_line_id": "c5f22b00baa845869ceb3a7d90d59bffccln",
  "decision": "REJECTED",
  "id": "7d903b7483294e3b902b89097d699dbdccla",
  "identification_id": "51462340e8653f8e2864801e8ebb4131cidt",
  "mandate_reference_number": "LXD3RGLRTP6HHM",
  "net_disposable_income": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "offered_interest_rate": 0.11,
  "offered_limit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
  "reason": "string",
  "recipient_iban": "DE13110101014386274299",
  "status": "rejected",
  "status_description": "Rejected by Scorer"
}