Skip to content
Splitpay
/
/
Update the reference acco...

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

Retrieve a single credit line

Request

Returns the details and status of a credit line associated with a specific customer.

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

CreditLine

Bodyapplication/json
idstringrequired

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

Example: "1908331fb8384edcbfe63067366c4b6accln"
person_idstringrequired

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

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
recipient_ibanstringrequired

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

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

The total amount of the customer's disposable income.

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

The amount value

Example: 1000
disposable_income.​currencystringrequired

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

Example: "EUR"
disposable_income.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
latest_disposable_incomeobject or null(SolarisToolkit.Web.Money.Optional)required

The amount of the customer's latest disposable income.

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

The amount value

Example: 1000
latest_disposable_income.​currencystringrequired

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

Example: "EUR"
latest_disposable_income.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
created_atstring(datetime)required

The timestamp from when the credit line was created.

Example: "2022-02-07T11:57:42"
interest_ratenumberrequired

The interest rate to apply to the credit line. This field is used if there's a specific interest rate to be applied for a partner.

Example: 0.11
annual_percentage_ratenumberrequired

The annual interest rate applied to the credit line.

Example: 0.11
limitobject(SolarisToolkit.Web.Money)required

The limit of the credit line.

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

The amount value

Example: 1000
limit.​currencystringrequired

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

Example: "EUR"
limit.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
statusstringrequired

The status of the credit line.

Enum"authorization_pending""account_creation_pending""mandate_creation_pending""open""closed"
Example: "mandate_creation_pending"
locking_statusstringrequired

The locking status, which indicates whether it's possible to create a loan against the credit line or it's blocked.

Enum"BLOCK""NO_BLOCK"
Example: "NO_BLOCK"
utilized_amountobject(SolarisToolkit.Web.Money)required

The utilized amount of the credit line limit.

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

The amount value

Example: 1000
utilized_amount.​currencystringrequired

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

Example: "EUR"
utilized_amount.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
active_loansArray of objectsrequired

An array containing the details of all active loans related to the customer's credit line.

active_loans[].​idstring

The unique ID of a loan.

Example: "e0167a47f385443a835050d1d9274b45cloa"
application_idstringrequired

The unique ID of a consumer credit line application.

Example: "35eee37033c5436f9cbff6df1f88e097ccla"
termination_typestring or null

The type of the credit line termination.

Enum"ORDINARY_BY_BANK""ORDINARY_BY_CUSTOMER"
Example: "ORDINARY_BY_CUSTOMER"
termination_requested_atstring or null(date)

The date when the credit line termination was requested.

Example: "2022-02-07"
termination_datestring or null(date)

The date when the credit line termination was effective.

Example: "2022-02-08"
renewalobject or null
product_typestring

The type of the credit line product.

Enum"freelancer""consumer"
Example: "consumer"
granted_atstring(datetime)

The timestamp from when the credit line was granted to a customer.

Example: "2022-02-07T11:57:42Z"
account_idstring or null

The unique ID of the customer's Solaris account.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
account_ibanstring or null

The IBAN of the customer's account.

Example: "DE25110101002910133758"
Response
application/json
{
  "utilized_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "termination_type": "ORDINARY_BY_CUSTOMER",
  "termination_requested_at": "2022-02-07",
  "termination_date": "2022-02-08",
  "status": "mandate_creation_pending",
  "renewal": {
    "status_description": "string",
    "status": "customer_notified",
    "rejection_date": "2022-10-31",
    "notification_sent_date": "2021-01-20",
    "id": "0696599d-7f0a-434b-b480-ebe5a1e20cc4",
    "effective_until_date": "2022-04-10",
    "effective_from_date": "2022-04-10",
    "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln"
  },
  "recipient_iban": "DE92370601930002130041",
  "product_type": "consumer",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "locking_status": "NO_BLOCK",
  "limit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "latest_disposable_income": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "interest_rate": 0.11,
  "id": "1908331fb8384edcbfe63067366c4b6accln",
  "granted_at": "2022-02-07T11:57:42Z",
  "disposable_income": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "created_at": "2022-02-07T11:57:42",
  "application_id": "35eee37033c5436f9cbff6df1f88e097ccla",
  "annual_percentage_rate": 0.11,
  "active_loans": [
    { … }
  ],
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
  "account_iban": "DE25110101002910133758"
}

Index all credit lines

Request

Returns an array of all credit lines 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 result by person_id

filter[status]string

Filter results by credit line status.

filter[granted_at_min]string

Filter results by the minimum date when the credit line was granted.

filter[granted_at_max]string

Filter results by the maximum date when the credit line was granted.

filter[id]string

Filter results by credit_line_id.

filter[eligible_renewal_expires_at_min]string

Filter by minimal expiration date for eligible renewal

filter[eligible_renewal_expires_at_max]string

Filter by maximal expiration date for eligible renewal

No request payload

Responses

ConsumerCreditLine.V1.ListCreditLinesResponse

Headers
totalinteger
Bodyapplication/jsonArray [
idstringrequired

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

Example: "1908331fb8384edcbfe63067366c4b6accln"
limitSolarisToolkit.Web.Money (object)required

The limit of the credit line.

SolarisToolkit.Web.Money (object)

The limit of the credit line.

person_idstringrequired

The person ID of the customer who has the credit line.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
statusstringrequired

The status of the credit line.

Enum"authorization_pending,""account_creation_pending""mandate_creation_pending""open""closed"
Example: "open"
granted_atstring or null(datetime)

The timestamp from when the credit line was granted to the customer.

Example: "2022-02-07T11:57:42Z"
]
Response
application/json
[
  {
    "status": "open",
    "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
    "limit": { … },
    "id": "1908331fb8384edcbfe63067366c4b6accln",
    "granted_at": "2022-02-07T11:57:42Z"
  }
]

Calculate all available installment plans for a given amount

Request

Creates possible installment plans for a requested amount. The credit line must have already been created before calling this endpoint. Afterward, you can create a loan for the customer based on one of these plans.

Path
person_idstringrequired

The person ID of the customer who has the credit line.

credit_line_idstringrequired

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

Bodyapplication/json

The criteria for calculating the available installment plans

amountobject(SolarisToolkit.Web.Money)required

The requested 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-06-22"
application/json
{
  "loan_type": "installment_plan",
  "interest_rate": 0.11,
  "bullet_loan_repayment_date": "2022-06-22",
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1
  }
}

Responses

Available 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 credit line loan

Request

Creates a credit line loan based on an installment plan. The loan is used for bank statements and should include a purpose and you must assign a reference to it. The credit line must have already been created without any blocks before creating a loan.

Path
person_idstringrequired

The person ID of the customer who has the credit line.

credit_line_idstringrequired

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

Bodyapplication/json

The application attributes

amountobject(SolarisToolkit.Web.Money)required

The loan amount.

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

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"
referencestringrequired

The reference number you internally assigned for the loan.

Example: "ABH244919"
purposestring<= 255 charactersrequired

The purpose of the loan.

Example: "Buying an iphone"
typestring

The type of the loan.

Default "installment_plan"
Enum"bullet""installment_plan"
Example: "installment_plan"
terminteger or null

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

Example: 6
interest_ratenumber or null(float)

The interest rate applied to the loan.

Example: 0.11
bullet_repayment_datestring or null(date)

The repayment date of the bullet loan.

Example: "2023-06-30"
application/json
{
  "type": "installment_plan",
  "term": 6,
  "reference": "ABH244919",
  "purpose": "Buying an iphone",
  "interest_rate": 0.11,
  "bullet_repayment_date": "2023-06-30",
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  }
}

Responses

Application

Bodyapplication/json
typestring

The type of the loan.

Enum"bullet""installment_plan"
Example: "installment_plan"
statusstring

The status of the loan.

Enum"payout_pending""payout_triggered""created""repaid"
Example: "payout_pending"
interest_ratenumber

The interest rate to apply to the loan. Only to be used if a special interest rate should apply.

Example: 0.11
idstring

The unique ID of a loan, generated after creating a loan.

Example: "f8930e8d3dfa48e4a898d7a97c0d78b4cloa"
effective_interest_ratenumber

The effective interest rate to apply to the loan.

Example: 0.0111
bullet_repayment_datestring or null(date)

The repayment date of the bullet loan.

Example: "2001-01-01"
Response
application/json
{
  "type": "installment_plan",
  "status": "payout_pending",
  "interest_rate": 0.11,
  "id": "f8930e8d3dfa48e4a898d7a97c0d78b4cloa",
  "effective_interest_rate": 0.0111,
  "bullet_repayment_date": "2001-01-01"
}

Revoke a credit line

Request

Revokes a credit line. Revoking a credit line must be done within 14 days from the issuance date.

Path
person_idstringrequired

The person ID of the customer who has 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

Update the reference account of a credit line

Request

Updates the external reference account associated with a customer's credit line. The account is used for the payout of a credit line loan.

Path
person_idstringrequired

The person ID of the customer who has the credit line.

credit_line_idstringrequired

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

Bodyapplication/json

Update reference account

ibanstring<= 34 charactersrequired

The IBAN of the external reference account to be linked to the credit line.

Example: "DE87110101001000057123"
mandate_numberstring<= 255 charactersrequired

The mandate number.

Example: "LUUJZMGP2IWIIE"
mandate_signature_datestring(date)required

The date on which the mandate was signed.

Example: "2022-02-07"
namestring or null<= 255 characters

The name of the account holder.

Example: "Lisa Hermann"
application/json
{
  "name": "Lisa Hermann",
  "mandate_signature_date": "2022-02-07",
  "mandate_number": "LUUJZMGP2IWIIE",
  "iban": "DE87110101001000057123"
}

Responses

No Content

Response
No content

Add internal payout account to a credit line

Request

Links a customer's internal payout account (i.e., an existing Solaris account) to their credit line. The account is used for the payout of a credit line loan.

Path
person_idstringrequired

The person ID of the customer who has the credit line.

credit_line_idstringrequired

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

Bodyapplication/json

Internal Payout Account Id

account_idstringrequired

The customer's internal bank account ID to be linked to the credit line.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
application/json
{
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc"
}

Responses

No Content

Response
No content

Download an annual account statement for a credit line

Request

Downloads an account statement for a credit line for a specific year as a PDF.

Path
person_idstringrequired

The person ID of the customer who has the credit line.

credit_line_idstringrequired

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

Query
yearintegerrequired

The year for which the annual statement is issued.

No request payload

Responses

The PDF binary of the annual account statement

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

Download a closing account statement for a credit line

Request

Downloads the closing account statement for a credit line as a PDF.

Path
person_idstringrequired

The person ID of the customer who has the credit line.

credit_line_idstringrequired

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

No request payload

Responses

The pdf binary of the closing account statement

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

Freelancer Credit Line

Operations