Skip to content
Splitpay
/
/
Retrieve a consumer credi...

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

Calculate anonymous installment plans for a given amount

Request

Generates an anonymous credit line installment plan for a specific amount, allowing potential customers to receive an initial offer before applying for a credit line.

Bodyapplication/json

Anonymous installment plans params

amountobject(SolarisToolkit.Web.Money)required

The requested credit line amount for which the installment plan is created.

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

The amount value

Example: 1000
amount.​currencystringrequired

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

Example: "EUR"
amount.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
loan_typestring or null

The loan type, which defines your product category.

Default "installment_plan"
Enum"bullet""installment_plan"
Example: "installment_plan"
interest_ratenumber or null(float)

The interest rate to apply to the installment loan.

Example: 0.11
bullet_loan_repayment_datestring or null(date)

The repayment date of the bullet loan.

Example: "2022-02-22"
application/json
{
  "loan_type": "installment_plan",
  "interest_rate": 0.11,
  "bullet_loan_repayment_date": "2022-02-22",
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1
  }
}

Responses

Anonymous Installment Plans

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

The number of months over which the installment loan will be repaid.

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

The monthly installment amount the customer has to pay.

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 of the installment loan (principal + interest) the customer must repay.

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 to apply to the installment loan. Optional field only if there's a specific interest rate that should apply to the loan.

Example: 0.11
installment_plans[].​effective_interest_ratenumberrequired

The effective interest rate to apply to the installment loan.

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

Create a consumer credit line application

Request

Creates a consumer credit line application and assigns it to the person with the person_id included in the request URL. The payload of this endpoint includes all the required financial information and account data about the applicant, which the credit scorer uses to initiate a series of credit checks. See the Consumer Splitpay guide for the list of mandatory properties.

Path
person_idstringrequired

The person ID of the customer applying for the credit line.

Bodyapplication/json

The application attributes

requested_credit_limitobject or null(SolarisToolkit.Web.Money.Optional)

The requested credit line amount.

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

The day of the month when the customer repays the monthly installment.

Default 1
Enum115
Example: 1
recipient_ibanstring or null

The IBAN of the customer's account to use for the account snapshot.

Example: "DE92370601930002130041"
private_insurance_amountobject or null(SolarisToolkit.Web.Money.Optional)

The amount of the private insurance the customer pays monthly.

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

Field to indicate whether the customer is already pre-selected based on your internal scoring flow.

Example: false
partner_scorestring or null

Field to enter your internal scoring of the customer.

partner_reference_numberstring or null

Field to enter your internal reference number for the customer.

Example: "AGHD02130041"
number_of_dependentsinteger or null

The number of persons depending on the customer's income, e.g., family members.

Example: 2
net_income_amountobject or null(SolarisToolkit.Web.Money.Optional)

The customer's monthly net income after deducting taxes.

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

Field to indicate whether the customer has moved and changed addresses in the last two years.

Example: false
marriage_statusstring or null

The customer's marital status.

Enum"MARRIED""UNMARRIED""DIVORCED""UNKNOWN"
Example: "MARRIED"
living_situation_amountobject or null(SolarisToolkit.Web.Money.Optional)

The amount of the customer's living expenses, e.g., rent, mortgage, etc.

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

The customer's living situation.

Enum"LIVING_WITH_PARENTS""LIVING_IN_RENTED_HOUSE""LIVING_IN_OWN_HOUSE"
Example: "LIVING_IN_RENTED_HOUSE"
identification_idstring or null

The unique ID of a customer's identification resource.

Example: "9dfe2f4edaa67138be0c0c1cd3a7d849cidt"
existing_credit_repayment_excluding_mortgageobject or null(SolarisToolkit.Web.Money.Optional)

The amount of existing credit repayment the customer pays, excluding mortgage.

Example: {"currency":"EUR","unit":"cents","value":1000}
employment_sincestring or null(date)

The date when the customer began their current employment.

Example: "2019-11-01"
credit_record_idstring or null

The unique ID of a customer's credit record.

Example: "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
application/json
{
  "requested_credit_limit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "repayment_day_of_month": 1,
  "recipient_iban": "DE92370601930002130041",
  "private_insurance_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "pre_selected_by_partner": false,
  "partner_score": "string",
  "partner_reference_number": "AGHD02130041",
  "number_of_dependents": 2,
  "net_income_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "moved_in_last_two_years": false,
  "marriage_status": "MARRIED",
  "living_situation_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "living_situation": "LIVING_IN_RENTED_HOUSE",
  "identification_id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
  "existing_credit_repayment_excluding_mortgage": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "employment_since": "2019-11-01",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a consumer credit line application.

Example: "35eee37033c5436f9cbff6df1f88e097ccla"
decisionstring or nullrequired

Solaris' decision on the credit line application.

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

The status of a consumer credit line application.

Enum"initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""identification_pending""offered""esign_pending""esign_complete""esign_failed""credit_line_creation_pending""credit_line_created"
Example: "account_snapshot_pending"
person_idstringrequired

The person ID of the customer applying for the credit line.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
status_descriptionstring or null

Additional details about the credit line application status.

signing_idstring or null

The ID of the signing resource, created after the customer's identification and e-signing process has been triggered.

Example: "7c63600ddddec4f2668893af39c1b814csig"
scoring_workflowobject or null

An object containing certain actions required for the scoring process.

recipient_ibanstring or null

The IBAN of the customer's account to use for the account snapshot.

Example: "DE92370601930002130041"
reasonstring or null

The reason(s) for rejecting a credit line application.

partner_reference_numberstring or null

The partner reference number.

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

The offered credit line limit.

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

The offered interest rate to apply to the credit line.

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

The net disposable income available to the customer after deducting all taxes.

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

The customer's marital status.

Enum"MARRIED""UNMARRIED""DIVORCED""UNKNOWN"
Example: "UNMARRIED"
identification_idstring or null

The unique ID of a customer's identification resource.

Example: "9e2e85c62230a652325964282c84559fcidt"
employment_statusstring or null

The customer's employment status.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "EMPLOYED"
credit_line_idstring or null

The unique ID of a credit line, generated after a credit line is created.

Example: "1908331fb8384edcbfe63067366c4b6accln"
Response
application/json
{
  "status_description": "string",
  "status": "account_snapshot_pending",
  "signing_id": "7c63600ddddec4f2668893af39c1b814csig",
  "scoring_workflow": {
    "required_actions": [ … ]
  },
  "recipient_iban": "DE92370601930002130041",
  "reason": "string",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_reference_number": "ABHP244919",
  "offered_limit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "offered_interest_rate": 2.5,
  "net_disposable_income": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "marriage_status": "UNMARRIED",
  "identification_id": "9e2e85c62230a652325964282c84559fcidt",
  "id": "35eee37033c5436f9cbff6df1f88e097ccla",
  "employment_status": "EMPLOYED",
  "decision": "OFFERED",
  "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln"
}

Retrieve a consumer credit line application

Request

Returns the current status and details of an existing consumer credit line application. Alternatively, you can subscribe to the webhook event CREDIT_LINE_APPLICATION to receive status updates on the application.

Path
person_idstringrequired

The person ID of the customer applying for the credit line.

application_idstringrequired

The unique credit line application ID assigned to a specific customer.

No request payload

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of a consumer credit line application.

Example: "35eee37033c5436f9cbff6df1f88e097ccla"
decisionstring or nullrequired

Solaris' decision on the credit line application.

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

The status of a consumer credit line application.

Enum"initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""identification_pending""offered""esign_pending""esign_complete""esign_failed""credit_line_creation_pending""credit_line_created"
Example: "account_snapshot_pending"
person_idstringrequired

The person ID of the customer applying for the credit line.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
status_descriptionstring or null

Additional details about the credit line application status.

signing_idstring or null

The ID of the signing resource, created after the customer's identification and e-signing process has been triggered.

Example: "7c63600ddddec4f2668893af39c1b814csig"
scoring_workflowobject or null

An object containing certain actions required for the scoring process.

recipient_ibanstring or null

The IBAN of the customer's account to use for the account snapshot.

Example: "DE92370601930002130041"
reasonstring or null

The reason(s) for rejecting a credit line application.

partner_reference_numberstring or null

The partner reference number.

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

The offered credit line limit.

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

The offered interest rate to apply to the credit line.

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

The net disposable income available to the customer after deducting all taxes.

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

The customer's marital status.

Enum"MARRIED""UNMARRIED""DIVORCED""UNKNOWN"
Example: "UNMARRIED"
identification_idstring or null

The unique ID of a customer's identification resource.

Example: "9e2e85c62230a652325964282c84559fcidt"
employment_statusstring or null

The customer's employment status.

Enum"EMPLOYED""UNEMPLOYED""PUBLIC_SECTOR_EMPLOYEE""PROFESSIONAL_SOLDIER""FREELANCER""HOUSEWORK""APPRENTICE""MANAGEMENT""RETIRED""STUDENT"
Example: "EMPLOYED"
credit_line_idstring or null

The unique ID of a credit line, generated after a credit line is created.

Example: "1908331fb8384edcbfe63067366c4b6accln"
Response
application/json
{
  "status_description": "string",
  "status": "account_snapshot_pending",
  "signing_id": "7c63600ddddec4f2668893af39c1b814csig",
  "scoring_workflow": {
    "required_actions": [ … ]
  },
  "recipient_iban": "DE92370601930002130041",
  "reason": "string",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_reference_number": "ABHP244919",
  "offered_limit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "offered_interest_rate": 2.5,
  "net_disposable_income": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "marriage_status": "UNMARRIED",
  "identification_id": "9e2e85c62230a652325964282c84559fcidt",
  "id": "35eee37033c5436f9cbff6df1f88e097ccla",
  "employment_status": "EMPLOYED",
  "decision": "OFFERED",
  "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln"
}

Index all credit line applications

Request

Returns an array of all credit line applications for all of your customers.

Query
page[number]integer

The number of result pages to return.

page[size]integer

The size of each result page (maximum amount of results) to return.

filter[person_id]string

Filter results by person_id.

filter[id]string

Filter results by application_id

filter[credit_line_id]string

Filter results by credit_line_id.

filter[status]string

Filter results by the application status

filter[application_date_min]string

Filter results by the minimum date when the application was created.

filter[application_date_max]string

Filter results by the maximum date when the application was created.

filter[credit_line_amount]integer

Filter results by the credit_line_amount.

No request payload

Responses

ConsumerCreditLineWeb.ListCreditLineApplicationsResponse

Headers
totalinteger
Bodyapplication/jsonArray [
idstringrequired

The unique ID of a consumer credit line application.

Example: "35eee37033c5436f9cbff6df1f88e097ccla"
person_idstringrequired

The person ID of the customer applying for the credit line.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of a consumer credit line application.

Enum"initial_scoring_pending""account_snapshot_pending""account_snapshot_verification_pending""identification_pending""offered""esign_pending""esign_complete""esign_failed""credit_line_creation_pending""credit_line_created"
Example: "credit_line_created"
created_atstringrequired

The timestamp from when the credit line was created.

Example: "2022-02-07T11:57:42"
limitobject or null(SolarisToolkit.Web.Money.Optional)

The limit of the credit line.

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

The unique ID of a credit line, generated after a credit line is created.

Example: "1908331fb8384edcbfe63067366c4b6accln"
]
Response
application/json
[
  {
    "status": "credit_line_created",
    "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
    "limit": { … },
    "id": "35eee37033c5436f9cbff6df1f88e097ccla",
    "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln",
    "created_at": "2022-02-07T11:57:42"
  }
]

Link a credit record to a consumer credit line application

Request

Attaches a customer's credit record to their credit line application. A credit record is required for the credit scoring process.

Path
person_idstringrequired

The person ID of the customer applying for the credit line.

application_idstringrequired

The unique credit line application ID assigned to a specific customer.

Bodyapplication/json

Credit record link

credit_record_idstringrequired

The unique ID of a customer's credit record.

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

Responses

No Content

Response
No content

Link an account snapshot to a consumer credit line application

Request

Links a customer account snapshot to their existing credit line application. You must add the account_snapshot_id in the request body.
The credit scorer uses the account snapshot for the final verification check to verify the financial information shared about the customer. After the final verification is completed, the credit scorer gives the final decision on the credit line application.

Path
person_idstringrequired

The person ID of the customer applying for the credit line.

application_idstringrequired

The unique credit line application ID assigned to a specific customer.

Bodyapplication/json

Account Snapshot link

account_snapshot_idstringrequired

The unique ID of a customer's account snapshot.

Example: "6c8f81a234df4052a9cde197577347b7snap"
application/json
{
  "account_snapshot_id": "6c8f81a234df4052a9cde197577347b7snap"
}

Responses

No Content

Response
No content

Link a customer identification to a credit line application

Request

Links a customer identification resource to their credit line application. You must add the identification_id in the request body. To retrieve the identification ID, call the GET Retrieve consumer credit line application. It should be included in the payload as soon as the identification has been created for the customer.

Path
person_idstringrequired

The person ID of the customer applying for the credit line.

application_idstringrequired

The unique consumer credit line application ID assigned to a specific customer.

Bodyapplication/json

The identification id to attach to the application.

identification_idstringrequired

The unique ID of a customer's identification resource.

Example: "9e2e85c62230a652325964282c84559fcidt"
application/json
{
  "identification_id": "9e2e85c62230a652325964282c84559fcidt"
}

Responses

No Content

Response
No content

Authorize a credit Line

Request

This endpoint enables an additional authorization flow from your side in specific use cases. After Solaris approves the credit line application, you can call this endpoint to authorize the credit line internally before it can be issued to the customer.

Path
person_idstringrequired

The person ID of the customer who is applying for the credit line.

credit_line_idstringrequired

The unique credit line ID, generated after a credit line is created.

No request payload

Responses

No Content

Response
No content

Download the pre-contractual information for consumer credit line

Request

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.

Path
person_idstringrequired

The person ID of the customer applying for the credit line.

application_idstringrequired

The unique consumer credit line application ID assigned to a specific customer.

No request payload

Responses

The binary of the pre-contractual information (SECCI)

Bodyapplication/pdf
string(binary)(ConsumerCreditLineWeb.DownloadPreContractResponse)
Response
No content

Download the final contract for consumer credit line

Request

Generates the final contract for a consumer credit line, which the customer must e-sign during the identification and e-signing process.

Path
person_idstringrequired

The person ID of the customer applying for the credit line.

application_idstringrequired

The unique credit line application ID assigned to a specific customer.

No request payload

Responses

The pdf binary of the contract

Bodyapplication/pdf
string(binary)(ConsumerCreditLineWeb.DownloadContractResponse)
Response
No content

Confirm sending the renewal notification to the customer

Request

(France only) Sends a confirmation to Solaris that you've sent the renewal notification to the customer. You have to add the exact date when the renewal notification was sent in the request body.

Path
person_idstringrequired

Person ID

credit_line_idstringrequired

Credit Line ID

Bodyapplication/json

Receive partner notification about customer renewal notification

notification_sent_datestring(date)required

The date the renewal notification was sent to the customer.

Example: "2022-02-25"
application/json
{
  "notification_sent_date": "2022-02-25"
}

Responses

No Content

Response
No content

Cancel a consumer credit line renewal

Request

(France only) Cancels the renewal of an existing credit line after receiving a renewal notification. Call this endpoint if the customer doesn't wish to renew the credit line.

Path
person_idstringrequired

The person ID of the customer for whom the credit line is issued.

credit_line_idstringrequired

The unique credit line ID, generated after a credit line is created.

No request payload

Responses

No Content

Response
No content

Credit Line Servicing

Operations

Freelancer Credit Line

Operations