Skip to content
Fronting
/
/
Retrieve business frontin...

Fronting (1.0)

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

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

Consumer fronting

Operations

Business fronting

Operations

Create business fronting loan or fronting factoring application

Request

Creates a fronting loan or fronting factoring application and assigns it to the business with the business_id specified in the request URL. The payload of this endpoint includes all the required financial information and account data about the business, which the credit scorer uses to initiate a series of credit checks to determine the business's credit risk and eligibility.

Path
business_idstringrequired

The ID of the business applying for a fronting loan or fronting factoring.

Bodyapplication/json

The application attributes

requested_amountobject(SolarisToolkit.Web.Money)required
Example: {"currency":"EUR","unit":"cents","value":1000}
requested_amount.​valueintegerrequired

The amount value

Example: 1000
requested_amount.​currencystringrequired

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

Example: "EUR"
requested_amount.​unitstringrequired

The unit of the given value.

Value"cents"
Example: "cents"
agionumber(float)

The credit commission amount.

Default 0
Example: 0
creditreform_pdstring<= 255 characters

The business's probability of default as scored by any credit risk service provider, e.g., Creditreform.

Example: "0.10"
creditreform_scoreinteger

The business's credit score as scored by any credit risk service provider, e.g., Creditreform.

Example: 2
durationinteger

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

Example: 24
effective_interest_ratenumber(float)

The effective annual interest rate applied to the loan.

Example: 0.309
factoring_feeobject or null(SolarisToolkit.Web.Money)
Example: {"currency":"EUR","unit":"cents","value":1000}
minimum_credit_risk_criteriaobject or null

Minimum credit risk criteria fields for scorer

nominal_interest_ratenumber(float)

The nominal interest rate applied to the loan.

Example: 0.299
partner_contact_namestring<= 255 characters

Your internal contact name for the business.

Example: "Daniel Schmidt"
partner_contact_numberstring<= 255 characters

Your internal contact number for the business.

Example: "+49345195891"
partner_reference_numberstring<= 255 characters

our internal reference number for the business. Acts as an idempotency key.

Example: "tf2df3ceac0e384352b78cb6987d1d987"
partner_scorestring<= 255 characters

The score assigned to the business by your internal scoring flow.

Example: "AA"
purposestring<= 255 characters

The purpose of the loan.

Example: "Buying office equipment, factoring of receivables, etc."
purpose_descriptionstring<= 255 characters

Additional information about the purpose of the loan.

recipient_ibanstring<= 255 characters

The IBAN of the loan's recipient, to which the loan will be paid out.

Example: "DE92370601930002130041"
recipient_namestring<= 255 characters

The name of the loan recipient.

Example: "Max Mustermann"
transaction_descriptionstring<= 70 characters

The transaction reference, which the recipient will see. Only use characters allowed by SEPA in this field.

Example: "Example transaction."
transaction_end_to_end_idstring^([A-Za-z0-9]|[+\?/\-:\(\)\.,']){0,35}$

SEPA identifier (provided by the end customer who initiated the SEPA transaction), routed through the whole payment process. (Max 35 characters without whitespace)

Example: "DDHHDHG333243"
application/json
{
  "agio": 0,
  "creditreform_pd": "0.10",
  "creditreform_score": 2,
  "duration": 24,
  "effective_interest_rate": 0.309,
  "factoring_fee": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "minimum_credit_risk_criteria": {},
  "nominal_interest_rate": 0.299,
  "partner_contact_name": "Daniel Schmidt",
  "partner_contact_number": "+49345195891",
  "partner_reference_number": "tf2df3ceac0e384352b78cb6987d1d987",
  "partner_score": "AA",
  "purpose": "Buying office equipment, factoring of receivables, etc.",
  "purpose_description": "string",
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Max Mustermann",
  "requested_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "transaction_description": "Example transaction.",
  "transaction_end_to_end_id": "DDHHDHG333243"
}

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of the business fronting loan application.

Example: "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla"
statusstringrequired

The status of the business fronting loan application.

Enum"scoring_pending""risk_report_pending""pending""identification_pending""cdd_pending""approved""rejected""loan_created"
Example: "approved"
creditreform_pdstring or nullrequired

The business's probability of default as scored by any credit risk service provider, e.g., Creditreform.

Example: "0.10"
creditreform_scoreinteger or nullrequired

The business's credit score as scored by any credit risk service provider, e.g., Creditreform.

Example: 2
partner_reference_numberstringrequired

Your internal reference number for the business. Acts as an idempotency key.

Example: "tf2df3ceac0e384352b78cb6987d1d987"
partner_scorestringrequired

The score assigned to the business by your internal scoring flow.

Example: "AA"
purposestringrequired

The purpose of the loan.

Example: "Buying office equipment, factoring of receivables, etc."
recipient_ibanstringrequired

The IBAN of the loan's recipient, to which the loan will be paid out.

Example: "DE92370601930002130041"
recipient_namestringrequired

The name of the loan recipient.

Example: "Daniel Schmidt"
requested_amountobject(SolarisToolkit.Web.Money)required
Example: {"currency":"EUR","unit":"cents","value":1000}
requested_amount.​valueintegerrequired

The amount value

Example: 1000
requested_amount.​currencystringrequired

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

Example: "EUR"
requested_amount.​unitstringrequired

The unit of the given value.

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

The credit commission amount.

Example: 0
durationinteger or null

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

Example: 24
effective_interest_ratenumber or null(float)

The effective annual interest rate applied to the loan.

Example: 0.309
identification_idstring or null

The unique ID of the identification resource created for the business.

Example: "1063504cf74919f60ae4c806bdc9ce75bid"
minimum_credit_risk_criteriaobject or null

Minimum credit risk criteria fields for scorer

nominal_interest_ratenumber or null(float)

The nominal interest rate applied to the loan.

Example: 0.299
partner_contact_namestring or null

Your internal contact name for the business.

Example: "Daniel Schmidt"
partner_contact_numberstring or null

Your internal contact number for the business.

Example: "+49345195891"
purpose_descriptionstring or null

Additional information about the purpose of the loan. In case of factoring, include the invoice number and reference in this field.

Example: "Buying office equipment for new headquarters."
transaction_descriptionstring or null

The transaction reference, which the recipient will see. Only use characters allowed by SEPA in this field.

Example: "Example transaction"
transaction_end_to_end_idstring or null

SEPA identifier (provided by the end customer who initiated the SEPA transaction), routed through the whole payment process. (Max 35 characters without whitespace)

Example: "DDHHDHG333243"
Response
application/json
{
  "agio": 0,
  "creditreform_pd": "0.10",
  "creditreform_score": 2,
  "duration": 24,
  "effective_interest_rate": 0.309,
  "id": "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla",
  "identification_id": "1063504cf74919f60ae4c806bdc9ce75bid",
  "minimum_credit_risk_criteria": {},
  "nominal_interest_rate": 0.299,
  "partner_contact_name": "Daniel Schmidt",
  "partner_contact_number": "+49345195891",
  "partner_reference_number": "tf2df3ceac0e384352b78cb6987d1d987",
  "partner_score": "AA",
  "purpose": "Buying office equipment, factoring of receivables, etc.",
  "purpose_description": "Buying office equipment for new headquarters.",
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Daniel Schmidt",
  "requested_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "status": "approved",
  "transaction_description": "Example transaction",
  "transaction_end_to_end_id": "DDHHDHG333243"
}

Retrieve business fronting loan or fronting factoring application

Request

Returns the current status and details of an existing business fronting loan or fronting factoring application. Additionally, subscribe to the webhook event BUSINESS_FRONTING_APPLICATION to receive status updates on the application.

Path
business_idstringrequired

The ID of the business whose fronting loan or fronting factoring application you want to retrieve.

application_idstringrequired

The ID of the business fronting loan or fronting factoring application you want to retrieve.

No request payload

Responses

Application

Bodyapplication/json
idstringrequired

The unique ID of the business fronting loan application.

Example: "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla"
statusstringrequired

The status of the business fronting loan application.

Enum"scoring_pending""risk_report_pending""pending""identification_pending""cdd_pending""approved""rejected""loan_created"
Example: "approved"
creditreform_pdstring or nullrequired

The business's probability of default as scored by any credit risk service provider, e.g., Creditreform.

Example: "0.10"
creditreform_scoreinteger or nullrequired

The business's credit score as scored by any credit risk service provider, e.g., Creditreform.

Example: 2
partner_reference_numberstringrequired

Your internal reference number for the business. Acts as an idempotency key.

Example: "tf2df3ceac0e384352b78cb6987d1d987"
partner_scorestringrequired

The score assigned to the business by your internal scoring flow.

Example: "AA"
purposestringrequired

The purpose of the loan.

Example: "Buying office equipment, factoring of receivables, etc."
recipient_ibanstringrequired

The IBAN of the loan's recipient, to which the loan will be paid out.

Example: "DE92370601930002130041"
recipient_namestringrequired

The name of the loan recipient.

Example: "Daniel Schmidt"
requested_amountobject(SolarisToolkit.Web.Money)required
Example: {"currency":"EUR","unit":"cents","value":1000}
requested_amount.​valueintegerrequired

The amount value

Example: 1000
requested_amount.​currencystringrequired

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

Example: "EUR"
requested_amount.​unitstringrequired

The unit of the given value.

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

The credit commission amount.

Example: 0
durationinteger or null

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

Example: 24
effective_interest_ratenumber or null(float)

The effective annual interest rate applied to the loan.

Example: 0.309
identification_idstring or null

The unique ID of the identification resource created for the business.

Example: "1063504cf74919f60ae4c806bdc9ce75bid"
minimum_credit_risk_criteriaobject or null

Minimum credit risk criteria fields for scorer

nominal_interest_ratenumber or null(float)

The nominal interest rate applied to the loan.

Example: 0.299
partner_contact_namestring or null

Your internal contact name for the business.

Example: "Daniel Schmidt"
partner_contact_numberstring or null

Your internal contact number for the business.

Example: "+49345195891"
purpose_descriptionstring or null

Additional information about the purpose of the loan. In case of factoring, include the invoice number and reference in this field.

Example: "Buying office equipment for new headquarters."
transaction_descriptionstring or null

The transaction reference, which the recipient will see. Only use characters allowed by SEPA in this field.

Example: "Example transaction"
transaction_end_to_end_idstring or null

SEPA identifier (provided by the end customer who initiated the SEPA transaction), routed through the whole payment process. (Max 35 characters without whitespace)

Example: "DDHHDHG333243"
Response
application/json
{
  "agio": 0,
  "creditreform_pd": "0.10",
  "creditreform_score": 2,
  "duration": 24,
  "effective_interest_rate": 0.309,
  "id": "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla",
  "identification_id": "1063504cf74919f60ae4c806bdc9ce75bid",
  "minimum_credit_risk_criteria": {},
  "nominal_interest_rate": 0.299,
  "partner_contact_name": "Daniel Schmidt",
  "partner_contact_number": "+49345195891",
  "partner_reference_number": "tf2df3ceac0e384352b78cb6987d1d987",
  "partner_score": "AA",
  "purpose": "Buying office equipment, factoring of receivables, etc.",
  "purpose_description": "Buying office equipment for new headquarters.",
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Daniel Schmidt",
  "requested_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "status": "approved",
  "transaction_description": "Example transaction",
  "transaction_end_to_end_id": "DDHHDHG333243"
}

Link a document to a business fronting loan or fronting factoring application

Request

Links a document resource to a business fronting loan or fronting factoring application. Use this endpoint to upload the required documents for a fronting loan or fronting factoring, such as signed contracts, credit risk reports, or invoices. You must add the document_id and document_type in the request body. Note that you must make a separate API call for each document.

Path
business_idstringrequired

The ID of the business applying for a fronting loan or fronting factoring.

application_idstringrequired

The ID of the business fronting loan or fronting factoring application.

Bodyapplication/json

The application attributes

document_idstringrequired

The unique ID of the document resource.

Example: "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc"
document_typestringrequired

The type of the document.

Example: "SIGNED_CONTRACT"
application/json
{
  "document_id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  "document_type": "SIGNED_CONTRACT"
}

Responses

No Content

Response
No content

Link an identification resource to a business fronting loan or fronting factoring application

Request

Links a business identification resource to their fronting loan or fronting factoring application. Afterward, the business must complete the BKYC process successfully to move forward with the application. You must add the identification_id in the request body.

Path
business_idstringrequired

The ID of the business applying for a fronting loan or fronting factoring.

application_idstringrequired

The ID of the business fronting loan or fronting factoring application.

Bodyapplication/json

Attributes required for linking a document to an application

identification_idstringrequired

The unique ID of the identification resource created for the business.

Example: "1063504cf74919f60ae4c806bdc9ce75bid"
application/json
{
  "identification_id": "1063504cf74919f60ae4c806bdc9ce75bid"
}

Responses

No Content

Response
No content

Triggers the creation of a loan for a business fronting loan or fronting factoring application

Request

Triggers the loan creation process for the respective business application, without triggering the loan payout itself. You must add the settlement_account_iban in the request body, which is a Solaris account, from which the loan amount is transferred to the business's account.

Path
business_idstringrequired

The ID of the business applying for a fronting loan or fronting factoring.

application_idstringrequired

The ID of the business fronting loan or fronting factoring application.

Bodyapplication/json

Attributes required for a loan creation request

settlement_account_ibanstringrequired

The Solaris settlement account from which the loan amount is transferred to the business's account.

Example: "DE07110101014503906016"
application/json
{
  "settlement_account_iban": "DE07110101014503906016"
}

Responses

Loan

Bodyapplication/json
idstringrequired

The unique ID of a business fronting loan.

Example: "13651d2f3a274e768ec6d45b036e0f14bflo"
application_idstringrequired

The unique ID of the business fronting loan application.

Example: "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla"
agionumber(float)required

The credit commission amount.

Example: 0
durationintegerrequired

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

Example: 24
recipient_ibanstringrequired

The IBAN of the loan's recipient, to which the loan will be paid out.

Example: "DE92370601930002130041"
recipient_namestringrequired

The name of the loan recipient.

Example: "Max Mustermann"
effective_interest_ratenumber(float)required

The effective annual interest rate applied to the loan.

Example: 0.309
nominal_interest_ratenumber(float)required

The nominal interest rate applied to the loan.

Example: 0.299
amountobject(SolarisToolkit.Web.Money)required
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"
collateral_account_ibanstringrequired

Your Solaris prefund account from which the full loan amount (agio + net loan amount) must be transferred to Solaris' settlement account.

Example: "DE85110101014480677574"
collection_account_ibanstringrequired

Your account to which the agio is transferred.

Example: "DE87110101001000057123"
settlement_account_ibanstringrequired

The Solaris settlement account from which the loan amount is transferred to the business's account.

Example: "DE07110101014503906016"
statusstringrequired

The status of the business fronting loan.

Enum"payout_pending""payout_issued"
Example: "payout_issued"
status_reasonstring or null

The status reason of the business fronting loan.

Enum"closed""terminated"
Example: "closed"
Response
application/json
{
  "agio": 0,
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "application_id": "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla",
  "collateral_account_iban": "DE85110101014480677574",
  "collection_account_iban": "DE87110101001000057123",
  "duration": 24,
  "effective_interest_rate": 0.309,
  "id": "13651d2f3a274e768ec6d45b036e0f14bflo",
  "nominal_interest_rate": 0.299,
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Max Mustermann",
  "settlement_account_iban": "DE07110101014503906016",
  "status": "payout_issued",
  "status_reason": "closed"
}

Trigger the loan payout for a business fronting loan application

Request

Triggers the loan payout process to the respective business account. You must add the settlement_account_iban in the request body, which is a Solaris account, from which the loan amount is transferred to the business's account.

Path
business_idstringrequired

The ID of the business applying for a fronting loan.

application_idstringrequired

The ID of the business fronting loan application.

Bodyapplication/json

Attributes required for a payout request

settlement_account_ibanstringrequired

The Solaris settlement account from which the loan amount is transferred to the business's account.

Example: "DE07110101014503906016"
application/json
{
  "settlement_account_iban": "DE07110101014503906016"
}

Responses

Loan

Bodyapplication/json
idstringrequired

The unique ID of a business fronting loan.

Example: "13651d2f3a274e768ec6d45b036e0f14bflo"
application_idstringrequired

The unique ID of the business fronting loan application.

Example: "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla"
agionumber(float)required

The credit commission amount.

Example: 0
durationintegerrequired

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

Example: 24
recipient_ibanstringrequired

The IBAN of the loan's recipient, to which the loan will be paid out.

Example: "DE92370601930002130041"
recipient_namestringrequired

The name of the loan recipient.

Example: "Max Mustermann"
effective_interest_ratenumber(float)required

The effective annual interest rate applied to the loan.

Example: 0.309
nominal_interest_ratenumber(float)required

The nominal interest rate applied to the loan.

Example: 0.299
amountobject(SolarisToolkit.Web.Money)required
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"
collateral_account_ibanstringrequired

Your Solaris prefund account from which the full loan amount (agio + net loan amount) must be transferred to Solaris' settlement account.

Example: "DE85110101014480677574"
collection_account_ibanstringrequired

Your account to which the agio is transferred.

Example: "DE87110101001000057123"
settlement_account_ibanstringrequired

The Solaris settlement account from which the loan amount is transferred to the business's account.

Example: "DE07110101014503906016"
statusstringrequired

The status of the business fronting loan.

Enum"payout_pending""payout_issued"
Example: "payout_issued"
status_reasonstring or null

The status reason of the business fronting loan.

Enum"closed""terminated"
Example: "closed"
Response
application/json
{
  "agio": 0,
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "application_id": "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla",
  "collateral_account_iban": "DE85110101014480677574",
  "collection_account_iban": "DE87110101001000057123",
  "duration": 24,
  "effective_interest_rate": 0.309,
  "id": "13651d2f3a274e768ec6d45b036e0f14bflo",
  "nominal_interest_rate": 0.299,
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Max Mustermann",
  "settlement_account_iban": "DE07110101014503906016",
  "status": "payout_issued",
  "status_reason": "closed"
}

(Factoring only) Trigger a partial loan payout for a business fronting factoring

Request

Triggers a partial loan payout related to a business fronting factoring application. The loan payout is used to purchase receivables in multiple partial payouts. You must add the required transaction details in the request body.

Path
business_idstringrequired

The ID of the business that applied for the fronting factoring.

loan_idstringrequired

The ID of the loan for which a partial payout is made.

Bodyapplication/json

Attributes required for a payout

transaction_descriptionstringrequired

The transaction reference, which the recipient will see. Only use characters allowed by SEPA in this field.

Example: "Example transaction."
transaction_end_to_end_idstringrequired

SEPA identifier (provided by the end customer who initiated the SEPA transaction), routed through the whole payment process. (Max 35 characters without whitespace).

Example: "DDHHDHG333243"
recipient_ibanstringrequired

The IBAN of the recipient of the loan payout.

Example: "DE15100100100003404109"
recipient_namestringrequired

The name of the recipient of the loan payout.

Example: "Daniel Schmidt"
amountobject(SolarisToolkit.Web.Money)required
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"
tagstring

The type of the partial loan payout related to a fronting factoring transaction.

Default "INITIAL_PAYOUT"
Enum"INITIAL_PAYOUT""RETENTION_FEE""FACTORING_INTEREST""VAT_TRANSFER"
Example: "INITIAL_PAYOUT"
application/json
{
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "recipient_iban": "DE15100100100003404109",
  "recipient_name": "Daniel Schmidt",
  "tag": "INITIAL_PAYOUT",
  "transaction_description": "Example transaction.",
  "transaction_end_to_end_id": "DDHHDHG333243"
}

Responses

Payout

Bodyapplication/json
idstringrequired

The unique ID of a business fronting loan's payout.

Example: "963347398e47416c9df216a63ef035c2bflp"
loan_idstringrequired

The unique ID of the business fronting loan.

Example: "29e1a05906954ce082ec779d81de8c1ebflo"
recipient_ibanstringrequired

The IBAN of the loan payout's recipient.

Example: "DE92370601930002130041"
recipient_namestringrequired

The name of the loan payout's recipient.

Example: "Max Mustermann"
tagstringrequired

The tag of the business fronting loan's payout.

Enum"INITIAL_PAYOUT""RETENTION_FEE""FACTORING_INTEREST"
Example: "INITIAL_PAYOUT"
statusstringrequired

The status of the business fronting loan's payout.

Enum"transfers_pending""transfers_complete"
Example: "transfers_pending"
amountobject(SolarisToolkit.Web.Money)required
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"
transaction_descriptionstring or null

The transaction reference, which the recipient will see. Only use characters allowed by SEPA in this field.

Example: "Example transaction."
transaction_end_to_end_idstring or null

SEPA identifier (provided by the end customer who initiated the SEPA transaction), routed through the whole payment process. (Max 35 characters without whitespace)

Example: "DDHHDHG333243"
Response
application/json
{
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "id": "963347398e47416c9df216a63ef035c2bflp",
  "loan_id": "29e1a05906954ce082ec779d81de8c1ebflo",
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Max Mustermann",
  "status": "transfers_pending",
  "tag": "INITIAL_PAYOUT",
  "transaction_description": "Example transaction.",
  "transaction_end_to_end_id": "DDHHDHG333243"
}

Retrieve business fronting loan's payout

Request

Returns the details of a loan's payout related to a fronting loan or fronting factoring, assigned to the business with the business_id and loan_id specified in the request URL. Additionally, subscribe to the webhook event BUSINESS_FRONTING_PAYOUT_UPDATE to receive status updates about the payout.

Path
business_idstringrequired

The ID of the business whose loan payout you want to retrieve.

loan_idstringrequired

The ID of the loan whose payout you want to retrieve.

payout_idstringrequired

The ID of the loan's payout you want to retrieve.

No request payload

Responses

Payout

Bodyapplication/json
idstringrequired

The unique ID of a business fronting loan's payout.

Example: "963347398e47416c9df216a63ef035c2bflp"
loan_idstringrequired

The unique ID of the business fronting loan.

Example: "29e1a05906954ce082ec779d81de8c1ebflo"
recipient_ibanstringrequired

The IBAN of the loan payout's recipient.

Example: "DE92370601930002130041"
recipient_namestringrequired

The name of the loan payout's recipient.

Example: "Max Mustermann"
tagstringrequired

The tag of the business fronting loan's payout.

Enum"INITIAL_PAYOUT""RETENTION_FEE""FACTORING_INTEREST"
Example: "INITIAL_PAYOUT"
statusstringrequired

The status of the business fronting loan's payout.

Enum"transfers_pending""transfers_complete"
Example: "transfers_pending"
amountobject(SolarisToolkit.Web.Money)required
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"
transaction_descriptionstring or null

The transaction reference, which the recipient will see. Only use characters allowed by SEPA in this field.

Example: "Example transaction."
transaction_end_to_end_idstring or null

SEPA identifier (provided by the end customer who initiated the SEPA transaction), routed through the whole payment process. (Max 35 characters without whitespace)

Example: "DDHHDHG333243"
Response
application/json
{
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "id": "963347398e47416c9df216a63ef035c2bflp",
  "loan_id": "29e1a05906954ce082ec779d81de8c1ebflo",
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Max Mustermann",
  "status": "transfers_pending",
  "tag": "INITIAL_PAYOUT",
  "transaction_description": "Example transaction.",
  "transaction_end_to_end_id": "DDHHDHG333243"
}

Retrieve business fronting loan

Request

Returns all the details of an existing business fronting loan, assigned to the customer with the business_id specified in the request URL. Additionally, subscribe to the webhook event BUSINESS_FRONTING_LOAN_PAYOUT to receive status updates about the loan.

Path
business_idstringrequired

The ID of the business that has the fronting loan.

loan_idstringrequired

The ID of a fronting loan associated with a specific business.

No request payload

Responses

Loan

Bodyapplication/json
idstringrequired

The unique ID of a business fronting loan.

Example: "13651d2f3a274e768ec6d45b036e0f14bflo"
application_idstringrequired

The unique ID of the business fronting loan application.

Example: "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla"
agionumber(float)required

The credit commission amount.

Example: 0
durationintegerrequired

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

Example: 24
recipient_ibanstringrequired

The IBAN of the loan's recipient, to which the loan will be paid out.

Example: "DE92370601930002130041"
recipient_namestringrequired

The name of the loan recipient.

Example: "Max Mustermann"
effective_interest_ratenumber(float)required

The effective annual interest rate applied to the loan.

Example: 0.309
nominal_interest_ratenumber(float)required

The nominal interest rate applied to the loan.

Example: 0.299
amountobject(SolarisToolkit.Web.Money)required
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"
collateral_account_ibanstringrequired

Your Solaris prefund account from which the full loan amount (agio + net loan amount) must be transferred to Solaris' settlement account.

Example: "DE85110101014480677574"
collection_account_ibanstringrequired

Your account to which the agio is transferred.

Example: "DE87110101001000057123"
settlement_account_ibanstringrequired

The Solaris settlement account from which the loan amount is transferred to the business's account.

Example: "DE07110101014503906016"
statusstringrequired

The status of the business fronting loan.

Enum"payout_pending""payout_issued"
Example: "payout_issued"
status_reasonstring or null

The status reason of the business fronting loan.

Enum"closed""terminated"
Example: "closed"
Response
application/json
{
  "agio": 0,
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "application_id": "89d4eaaa73ec4a73a0b9d40fb5d9da9cbfla",
  "collateral_account_iban": "DE85110101014480677574",
  "collection_account_iban": "DE87110101001000057123",
  "duration": 24,
  "effective_interest_rate": 0.309,
  "id": "13651d2f3a274e768ec6d45b036e0f14bflo",
  "nominal_interest_rate": 0.299,
  "recipient_iban": "DE92370601930002130041",
  "recipient_name": "Max Mustermann",
  "settlement_account_iban": "DE07110101014503906016",
  "status": "payout_issued",
  "status_reason": "closed"
}

Terminate a business fronting loan

Request

Terminates a business fronting loan.

Path
business_idstringrequired

The ID of the business whose loan you want to terminate.

loan_idstringrequired

The ID of the loan that you want to terminate.

No request payload

Responses

No Content

Response
No content

Retrieve the details of the business relationship with a customer

Request

Returns the details of an existing business relationship with the customer with the business_id specified in the request URL. Additionally, subscribe to the webhook event BUSINESS_FRONTING_RELATIONSHIP_STATUS_CHANGED to receive status updates about changes to the business relationship.

Path
business_idstringrequired

The ID of the business.

No request payload

Responses

Business relationship

Bodyapplication/json
business_idstringrequired

The ID of the business.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
statusstringrequired

The status of the business relationship.

Enum"active""closed""blocked"
Example: "closed"
created_atstring(datetime)required

The date when the business relationship was created.

Example: "2020-20-03T18:01:48.000Z"
updated_atstring(datetime)required

The date when the business relationship was last updated.

Example: "2021-20-03T18:01:48.000Z"
offboarded_atstring or null(datetime)

The date when the business was off-boarded.

Example: "2022-20-03T18:01:48.000Z"
status_reasonstring or null

Additional context about the reasons for a particular status.

Example: "offboarded_by_partner"
Response
application/json
{
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "created_at": "2020-20-03T18:01:48.000Z",
  "offboarded_at": "2022-20-03T18:01:48.000Z",
  "status": "closed",
  "status_reason": "offboarded_by_partner",
  "updated_at": "2021-20-03T18:01:48.000Z"
}

Terminate the business relationship with a customer

Request

Terminates the business relationship with the customer with the business_id specified in the request URL and sets the status_reason to offboarded_by_partner.

Path
business_idstringrequired

The ID of the business you want to terminate the business relationship with.

No request payload

Responses

No Content

Response
No content