Fronting (1.0)

Download OpenAPI specification:Download

Consumer fronting

Create consumer fronting loan application

Creates a consumer fronting loan application and assigns it to the person with the person_id specified in the request URL. 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.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer applying for a fronting loan.

Request Body schema: application/json

The application attributes

agio
number <float>
Default: 0

The credit commission amount.

credit_record_id
string or null

The unique ID of a customer's credit record.

debt_burden_ratio
number or null <float>

The ratio of the customer's total monthly outgoing payments (including installments towards loans and credit cards) to their total income. (0.0 means 0%, 100.0 means 100%, 1.0 means 1%)

effective_interest_rate
number or null <float>

The effective annual interest rate to apply to the fronting loan.

employment_since
string or null <date>

The date when the customer started their current employment.

employment_until
string or null <date>

The date when the customer ended an employment.

required
object

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

is_joint_application
boolean or null

A field to indicate whether the application is a joint application or not.

living_situation
required
string

The customer's living situation.

Enum: "LIVING_WITH_PARENTS" "LIVING_IN_RENTED_HOUSE" "LIVING_IN_OWN_HOUSE"
required
object

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

loan_purpose
required
string <= 255 characters

The purpose of the loan.

moved_in_last_two_years
boolean or null

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

required
object

The customer's net income amount.

number_of_kids
required
integer

The number of kids the customer has.

partner_reference_number
string or null <= 255 characters

Your internal reference number for the customer.

partner_score
string or null <= 255 characters

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

partner_snapshot_allowed
required
boolean

A field to indicate whether it's allowed for you to create an account snapshot for the customer or not.

payout_date
string or null <date>

The date when the loan was paid out to the customer.

required
object

The amount of the private insurance the customer pays monthly.

probability_of_default
number or null <float>

The percentage of the customer's probability of default as scored by your internal scoring system. (0.0 means 0%, 100.0 means 100%, 1.0 means 1%)

recipient_iban
string or null

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

recipient_name
string or null <= 255 characters

The name of the loan recipient.

repayment_day_of_month
required
integer

The day of the month when the customer pays the loan installment.

requested_interest_rate
required
number <float>

The requested interest rate to apply to the fronting loan.

required
object

The loan amount requested by the customer.

requested_loan_term
required
integer

The number of months over which the loan will be repaid, as requested by the customer.

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

The total interest amount applied to the loan.

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

The total principal amount of the loan.

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

The total amount the customer repaid from the loan.

transaction_description
required
string <= 70 characters

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

transaction_end_to_end_id
string^([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)

Responses
201

Application

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable Entity

post/v1/consumers/persons/{person_id}/fronting_loan_applications
Request samples
application/json
{
  • "agio": 0,
  • "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  • "debt_burden_ratio": 0,
  • "effective_interest_rate": 0.04,
  • "employment_since": "2019-08-24",
  • "employment_until": "2019-08-24",
  • "existing_credit_repayment_excluding_mortgage": {
    },
  • "is_joint_application": true,
  • "living_situation": "LIVING_IN_RENTED_HOUSE",
  • "living_situation_amount": {
    },
  • "loan_purpose": "Buying a car",
  • "moved_in_last_two_years": true,
  • "net_income_amount": {
    },
  • "number_of_kids": 1,
  • "partner_reference_number": "string",
  • "partner_score": "string",
  • "partner_snapshot_allowed": true,
  • "payout_date": "2021-08-24",
  • "private_insurance_amount": {
    },
  • "probability_of_default": 0,
  • "recipient_iban": "DE92370601930002130041",
  • "recipient_name": "Max Mustermann",
  • "repayment_day_of_month": 1,
  • "requested_interest_rate": 0.02,
  • "requested_loan_amount": {
    },
  • "requested_loan_term": 24,
  • "total_interest_amount": {
    },
  • "total_principle_amount": {
    },
  • "total_repaid_loan_amount": {
    },
  • "transaction_description": "string",
  • "transaction_end_to_end_id": "123322332"
}
Response samples
application/json
{
  • "account_snapshot_id": "2a9fbb2fc5be45f7b8ca782c45715576snap",
  • "agio": 0,
  • "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  • "debt_burden_ratio": 0,
  • "decision": "string",
  • "effective_interest_rate": 0.04,
  • "id": "504f3c3659e14079a6941fe5b7a75eaacfla",
  • "identification_origination_id": "ccf79efa8b5c4a5594d43b73e58acfb3io",
  • "loan_purpose": "Buying a car",
  • "net_income_amount": {
    },
  • "partner_id": "string",
  • "partner_reference_number": "string",
  • "partner_score": "string",
  • "partner_snapshot_allowed": true,
  • "payout_date": "2019-08-24",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "probability_of_default": 0,
  • "recipient_iban": "DE92370601930002130041",
  • "recipient_name": "Max Mustermann",
  • "requested_interest_rate": 0.02,
  • "requested_loan_amount": {
    },
  • "requested_loan_term": 24,
  • "status": "identification_pending",
  • "total_interest_amount": {
    },
  • "total_principle_amount": {
    },
  • "total_repaid_loan_amount": {
    },
  • "transaction_description": "string",
  • "transaction_end_to_end_id": "123322332"
}

Retrieve consumer fronting loan application

Returns the current status and details of an existing consumer fronting loan application. Alternatively, you can subscribe to the webhook event CONSUMER_FRONTING_APPLICATION to receive status updates on the application.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer applying for a fronting loan.

application_id
required
string

The unique ID of a consumer fronting loan application.

Responses
200

Application

403

Forbidden

404

Not Found

get/v1/consumers/persons/{person_id}/fronting_loan_applications/{application_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/consumers/persons/{person_id}/fronting_loan_applications/{application_id}'
Response samples
application/json
{
  • "account_snapshot_id": "2a9fbb2fc5be45f7b8ca782c45715576snap",
  • "agio": 0,
  • "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  • "debt_burden_ratio": 0,
  • "decision": "string",
  • "effective_interest_rate": 0.04,
  • "id": "504f3c3659e14079a6941fe5b7a75eaacfla",
  • "identification_origination_id": "ccf79efa8b5c4a5594d43b73e58acfb3io",
  • "loan_purpose": "Buying a car",
  • "net_income_amount": {
    },
  • "partner_id": "string",
  • "partner_reference_number": "string",
  • "partner_score": "string",
  • "partner_snapshot_allowed": true,
  • "payout_date": "2019-08-24",
  • "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  • "probability_of_default": 0,
  • "recipient_iban": "DE92370601930002130041",
  • "recipient_name": "Max Mustermann",
  • "requested_interest_rate": 0.02,
  • "requested_loan_amount": {
    },
  • "requested_loan_term": 24,
  • "status": "identification_pending",
  • "total_interest_amount": {
    },
  • "total_principle_amount": {
    },
  • "total_repaid_loan_amount": {
    },
  • "transaction_description": "string",
  • "transaction_end_to_end_id": "123322332"
}

Link an account snapshot to a consumer fronting loan application

Links a customer's account snapshot to their fronting loan application. You must include the account_snapshot_id in the payload of this endpoint. After the account snapshot is linked to the loan application, the application status transitions to scoring_pending.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer applying for a fronting loan.

application_id
required
string

The unique ID of a consumer fronting loan application.

Request Body schema: application/json

Account Snapshot link

account_snapshot_id
required
string

The unique ID of a customer's account snapshot.

Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

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

Link a customer identification origination to a consumer fronting loan application

Links the identification origination resource created for a customer to their fronting loan application. You must add the person_id and the application_id in the request URL and add the identification_origination_id in the request body.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer applying for a fronting loan.

application_id
required
string

The unique ID of a consumer fronting loan application.

Request Body schema: application/json

Put request

identification_origination_id
required
string

The unique ID of an identification origination resource created for a customer in the scope of a loan application.

Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

put/v1/consumers/persons/{person_id}/fronting_loan_applications/{application_id}/identification
Request samples
application/json
{
  • "identification_origination_id": "589e12da53154010ad180894acbe07ebio"
}
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

Trigger loan payout for a consumer fronting loan application

Triggers the loan payout process to the respective customer. 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 customer's account.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer applying for a fronting loan.

application_id
required
string

The unique ID of a consumer fronting loan application.

Request Body schema: application/json

Attributes required for a payout request

settlement_account_iban
required
string

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

Responses
201

Loan

400

Invalid request

403

Forbidden

404

Not Found

post/v1/consumers/persons/{person_id}/fronting_loan_applications/{application_id}/payout
Request samples
application/json
{
  • "settlement_account_iban": "DE07110101014503906016"
}
Response samples
application/json
{
  • "agio": 0,
  • "amount": {
    },
  • "application_id": "504f3c3659e14079a6941fe5b7a75eaacfla",
  • "collateral_account_iban": "DE85110101014480677574",
  • "collection_account_iban": "DE87110101001000057123",
  • "duration": 12,
  • "id": "620b95f7987243d398c2621c889a2039cflo",
  • "recipient_iban": "DE92370601930002130041",
  • "recipient_name": "Max Mustermann",
  • "requested_interest_rate": 0.04,
  • "settlement_account_iban": "DE07110101014503906016",
  • "status": "payout_issued"
}

Retrieve consumer fronting loan

Returns all the details and status of an existing consumer fronting loan assigned to the person with the given person_id in the request URL.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the fronting loan.

loan_id
required
string

The unique ID of a fronting loan associated with a specific customer.

Responses
200

Loan

403

Forbidden

404

Not Found

get/v1/consumers/persons/{person_id}/fronting_loans/{loan_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/consumers/persons/{person_id}/fronting_loans/{loan_id}'
Response samples
application/json
{
  • "agio": 0,
  • "amount": {
    },
  • "application_id": "504f3c3659e14079a6941fe5b7a75eaacfla",
  • "collateral_account_iban": "DE85110101014480677574",
  • "collection_account_iban": "DE87110101001000057123",
  • "duration": 12,
  • "id": "620b95f7987243d398c2621c889a2039cflo",
  • "recipient_iban": "DE92370601930002130041",
  • "recipient_name": "Max Mustermann",
  • "requested_interest_rate": 0.04,
  • "settlement_account_iban": "DE07110101014503906016",
  • "status": "payout_issued"
}

Update a consumer fronting loan applications

Request
Security:
path Parameters
person_id
required
string

Person ID

application_id
required
string

Application ID

Request Body schema: application/json

Attributes required for a payout request

recipient_iban
required
string
recipient_name
required
string
Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

patch/v1/consumers/persons/{person_id}/fronting_loan_applications/{application_id}/recipient_account
Request samples
application/json
{
  • "recipient_iban": "string",
  • "recipient_name": "string"
}
Response samples
application/json
{
  • "errors": [
    ]
}

Business fronting

Create business fronting loan or fronting factoring application

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.

Request
Security:
path Parameters
business_id
required
string

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

Request Body schema: application/json

The application attributes

agio
number <float>
Default: 0

The credit commission amount.

creditreform_pd
string <= 255 characters

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

creditreform_score
integer

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

duration
integer

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

effective_interest_rate
number <float>

The effective annual interest rate applied to the loan.

object

Minimum credit risk criteria fields for scorer

nominal_interest_rate
number <float>

The nominal interest rate applied to the loan.

partner_contact_name
string <= 255 characters

Your internal contact name for the business.

partner_contact_number
string <= 255 characters

Your internal contact number for the business.

partner_reference_number
string <= 255 characters

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

partner_score
string <= 255 characters

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

purpose
string <= 255 characters

The purpose of the loan.

purpose_description
string <= 255 characters

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

recipient_iban
string <= 255 characters

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

recipient_name
string <= 255 characters

The name of the loan recipient.

required
object

The requested loan amount.

transaction_description
string <= 70 characters

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

transaction_end_to_end_id
string^([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)

Responses
201

Application

400

Invalid request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post/v1/businesses/{business_id}/fronting_loan_applications
Request samples
application/json
{
  • "agio": 0,
  • "creditreform_pd": "0.10",
  • "creditreform_score": 2,
  • "duration": 24,
  • "effective_interest_rate": 0.309,
  • "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": {
    },
  • "transaction_description": "Example transaction.",
  • "transaction_end_to_end_id": "DDHHDHG333243"
}
Response samples
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": {
    },
  • "status": "approved",
  • "transaction_description": "Example transaction",
  • "transaction_end_to_end_id": "DDHHDHG333243"
}

Retrieve business fronting loan or fronting factoring application

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.

Request
Security:
path Parameters
business_id
required
string

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

application_id
required
string

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

Responses
200

Application

403

Forbidden

404

Not Found

get/v1/businesses/{business_id}/fronting_loan_applications/{application_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/fronting_loan_applications/{application_id}'
Response samples
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": {
    },
  • "status": "approved",
  • "transaction_description": "Example transaction",
  • "transaction_end_to_end_id": "DDHHDHG333243"
}

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

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.

Request
Security:
path Parameters
business_id
required
string

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

application_id
required
string

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

Request Body schema: application/json

The application attributes

document_id
required
string

The unique ID of the document resource.

document_type
required
string

The type of the document.

Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

put/v1/businesses/{business_id}/fronting_loan_applications/{application_id}/documents
Request samples
application/json
{
  • "document_id": "69ec2a9d8dbaf5ea1b13124098a34ea3cdoc",
  • "document_type": "SIGNED_CONTRACT"
}
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

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

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.

Request
Security:
path Parameters
business_id
required
string

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

application_id
required
string

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

Request Body schema: application/json

Attributes required for linking a document to an application

identification_id
required
string

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

Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

put/v1/businesses/{business_id}/fronting_loan_applications/{application_id}/identification
Request samples
application/json
{
  • "identification_id": "1063504cf74919f60ae4c806bdc9ce75bid"
}
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

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

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.

Request
Security:
path Parameters
business_id
required
string

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

application_id
required
string

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

Request Body schema: application/json

Attributes required for a loan creation request

settlement_account_iban
required
string

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

Responses
201

Loan

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

put/v1/businesses/{business_id}/fronting_loan_applications/{application_id}/loan
Request samples
application/json
{
  • "settlement_account_iban": "DE07110101014503906016"
}
Response samples
application/json
{
  • "agio": 0,
  • "amount": {
    },
  • "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

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.

Request
Security:
path Parameters
business_id
required
string

The ID of the business applying for a fronting loan.

application_id
required
string

The ID of the business fronting loan application.

Request Body schema: application/json

Attributes required for a payout request

settlement_account_iban
required
string

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

Responses
201

Loan

400

Invalid request

403

Forbidden

404

Not Found

post/v1/businesses/{business_id}/fronting_loan_applications/{application_id}/payout
Request samples
application/json
{
  • "settlement_account_iban": "DE07110101014503906016"
}
Response samples
application/json
{
  • "agio": 0,
  • "amount": {
    },
  • "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

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.

Request
Security:
path Parameters
business_id
required
string

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

loan_id
required
string

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

Request Body schema: application/json

Attributes required for a payout

required
object

The amount of the partial loan payout.

recipient_iban
required
string

The IBAN of the recipient of the loan payout.

recipient_name
required
string

The name of the recipient of the loan payout.

tag
string
Default: "INITIAL_PAYOUT"

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

Enum: "INITIAL_PAYOUT" "RETENTION_FEE" "FACTORING_INTEREST"
transaction_description
required
string

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

transaction_end_to_end_id
required
string

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

Responses
201

Payout

400

Invalid request

403

Forbidden

404

Not Found

post/v1/businesses/{business_id}/fronting_loans/{loan_id}/payouts
Request samples
application/json
{
  • "amount": {
    },
  • "recipient_iban": "DE15100100100003404109",
  • "recipient_name": "Daniel Schmidt",
  • "tag": "INITIAL_PAYOUT",
  • "transaction_description": "Example transaction.",
  • "transaction_end_to_end_id": "DDHHDHG333243"
}
Response samples
application/json
{
  • "amount": {
    },
  • "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

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.

Request
Security:
path Parameters
business_id
required
string

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

loan_id
required
string

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

payout_id
required
string

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

Responses
200

Payout

403

Forbidden

404

Not Found

get/v1/businesses/{business_id}/fronting_loans/{loan_id}/payouts/{payout_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/fronting_loans/{loan_id}/payouts/{payout_id}'
Response samples
application/json
{
  • "amount": {
    },
  • "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

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.

Request
Security:
path Parameters
business_id
required
string

The ID of the business that has the fronting loan.

loan_id
required
string

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

Responses
200

Loan

403

Forbidden

404

Not Found

get/v1/businesses/{business_id}/fronting_loans/{loan_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/fronting_loans/{loan_id}'
Response samples
application/json
{
  • "agio": 0,
  • "amount": {
    },
  • "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

Terminates a business fronting loan.

Request
Security:
path Parameters
business_id
required
string

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

loan_id
required
string

The ID of the loan that you want to terminate.

Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

post/v1/businesses/{business_id}/fronting_loans/{loan_id}/terminate
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/fronting_loans/{loan_id}/terminate'
Response samples
application/json
{
  • "errors": [
    ]
}

Retrieve the details of the business relationship with a customer

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.

Request
Security:
path Parameters
business_id
required
string

The ID of the business.

Responses
200

Business relationship

403

Forbidden

404

Not Found

get/v1/businesses/{business_id}/fronting_loans_business_relationship
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/fronting_loans_business_relationship'
Response samples
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

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.

Request
Security:
path Parameters
business_id
required
string

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

Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

post/v1/businesses/{business_id}/fronting_loans_business_relationship/close
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/businesses/{business_id}/fronting_loans_business_relationship/close'
Response samples
application/json
{
  • "errors": [
    ]
}