# Splitpay Version: 1.0 ## Servers Sandbox ``` https://api.solaris-sandbox.de ``` Production ``` https://api.solarisbank.de ``` ## Download OpenAPI description [Splitpay](https://docs.solarisgroup.com/_spec/api-reference/lending/splitpay.yaml) ## Consumer Credit Line ### Calculate anonymous installment plans for a given amount - [POST /v1/anonymous_credit_line_installment_plans](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.consumercreditlines.anonymousinstallmentplans.indexoperation.md): 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. ### Create a consumer credit line application - [POST /v1/persons/{person_id}/credit_line_applications](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.applications.createoperation.md): Creates a consumer credit line application and assigns it to the person with the 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. ### Retrieve a consumer credit line application - [GET /v1/persons/{person_id}/credit_line_applications/{application_id}](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.applications.showoperation.md): Returns the current status and details of an existing consumer credit line application. Alternatively, you can subscribe to the webhook event to receive status updates on the application. ### Index all credit line applications - [GET /v1/persons/credit_line_applications](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.applications.indexoperation.md): Returns an array of all credit line applications for all of your customers. ### Link a credit record to a consumer credit line application - [PUT /v1/persons/{person_id}/credit_line_applications/{application_id}/credit_record](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.applications.linkcreditrecordoperation.md): Attaches a customer's credit record to their credit line application. A credit record is required for the credit scoring process. ### Link an account snapshot to a consumer credit line application - [PUT /v1/persons/{person_id}/credit_line_applications/{application_id}/account_snapshot](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.applications.linkaccountsnapshotoperation.md): Links a customer account snapshot to their existing credit line application. You must add the 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. ### Link a customer identification to a credit line application - [PUT /v1/persons/{person_id}/credit_line_applications/{application_id}/identification](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.applications.linkidentificationoperation.md): 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. ### Authorize a credit Line - [PUT /v1/persons/{person_id}/credit_lines/{credit_line_id}/authorization](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.consumercreditlines.authorizeoperation.md): 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. ### Download the pre-contractual information for consumer credit line - [GET /v1/persons/{person_id}/credit_line_applications/{application_id}/pre_contract](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.applications.downloadprecontractoperation.md): 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. ### Download the final contract for consumer credit line - [GET /v1/persons/{person_id}/credit_line_applications/{application_id}/contract](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.applications.downloadcontractoperation.md): Generates the final contract for a consumer credit line, which the customer must e-sign during the identification and e-signing process. ### Confirm sending the renewal notification to the customer - [PATCH /v1/persons/{person_id}/credit_lines/{credit_line_id}/renewal/customer_notified](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.consumercreditlines.renewals.customernotifiedoperation.md): (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. ### Cancel a consumer credit line renewal - [POST /v1/persons/{person_id}/credit_lines/{credit_line_id}/renewal/cancel](https://docs.solarisgroup.com/api-reference/lending/splitpay/consumer-credit-line/consumercreditlineweb.v1.consumercreditlines.renewals.canceloperation.md): (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. ## Credit Line Servicing ### Retrieve a single credit line - [GET /v1/persons/{person_id}/credit_lines/{credit_line_id}](https://docs.solarisgroup.com/api-reference/lending/splitpay/credit-line-servicing/consumercreditlineweb.v1.consumercreditlines.showoperation.md): Returns the details and status of a credit line associated with a specific customer. ### Index all credit lines - [GET /v1/persons/credit_lines](https://docs.solarisgroup.com/api-reference/lending/splitpay/credit-line-servicing/consumercreditlineweb.v1.consumercreditlines.indexoperation.md): Returns an array of all credit lines for all of your customers. ### Calculate all available installment plans for a given amount - [POST /v1/persons/{person_id}/credit_lines/{credit_line_id}/available_installment_plans](https://docs.solarisgroup.com/api-reference/lending/splitpay/credit-line-servicing/consumercreditlineweb.v1.consumercreditlines.availableinstallmentplans.indexoperation.md): 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. ### Create a credit line loan - [POST /v1/persons/{person_id}/credit_lines/{credit_line_id}/loans](https://docs.solarisgroup.com/api-reference/lending/splitpay/credit-line-servicing/consumercreditlineweb.v1.loans.createoperation.md): Creates a credit line loan based on an installment plan. The loan is used for bank statements and should include a and you must assign a to it. The credit line must have already been created without any blocks before creating a loan. ### Revoke a credit line - [PUT /v1/persons/{person_id}/credit_lines/{credit_line_id}/revoke](https://docs.solarisgroup.com/api-reference/lending/splitpay/credit-line-servicing/consumercreditlineweb.v1.consumercreditlines.revokeoperation.md): Revokes a credit line. Revoking a credit line must be done within 14 days from the issuance date. ### Update the reference account of a credit line - [PATCH /v1/persons/{person_id}/credit_lines/{credit_line_id}/reference_account](https://docs.solarisgroup.com/api-reference/lending/splitpay/credit-line-servicing/consumercreditlineweb.v1.consumercreditlines.updatereferenceaccountoperation.md): Updates the external reference account associated with a customer's credit line. The account is used for the payout of a credit line loan. ### Add internal payout account to a credit line - [PATCH /v1/persons/{person_id}/credit_lines/{credit_line_id}/payout_account](https://docs.solarisgroup.com/api-reference/lending/splitpay/credit-line-servicing/consumercreditlineweb.v1.consumercreditlines.updatepayoutaccountoperation.md): 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. ### Download an annual account statement for a credit line - [GET /v1/persons/{person_id}/credit_lines/{credit_line_id}/annual_account_statement](https://docs.solarisgroup.com/api-reference/lending/splitpay/credit-line-servicing/consumercreditlineweb.v1.consumercreditlines.downloadannualaccountstatementoperation.md): Downloads an account statement for a credit line for a specific year as a PDF. ### Download a closing account statement for a credit line - [GET /v1/persons/{person_id}/credit_lines/{credit_line_id}/closing_account_statement](https://docs.solarisgroup.com/api-reference/lending/splitpay/credit-line-servicing/consumercreditlineweb.v1.consumercreditlines.downloadclosingaccountstatementoperation.md): Downloads the closing account statement for a credit line as a PDF. ## Freelancer Credit Line ### Calculate anonymous installment plans for a given amount - [POST /v1/freelancers/anonymous_credit_line_installment_plans](https://docs.solarisgroup.com/api-reference/lending/splitpay/freelancer-credit-line/freelancercreditlineweb.v1.creditlines.anonymousinstallmentplans.indexoperation.md): Generates an anonymous credit line installment plan for a specific amount, including the monthly installment amount, the loan duration, and the applicable interest rates, allowing potential customers to receive an initial offer before applying for a credit line. ### Create freelancer credit line application - [POST /v1/freelancers/persons/{person_id}/credit_line_applications](https://docs.solarisgroup.com/api-reference/lending/splitpay/freelancer-credit-line/freelancercreditlineweb.v1.applications.createoperation.md): Creates a freelancer credit line application. The payload of this endpoint includes all the required financial information and account data about the customer, which the credit scorer uses to initiate a series of credit checks to determine the customer's credit risk and eligibility. ### Retrieve freelancer credit line application - [GET /v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}](https://docs.solarisgroup.com/api-reference/lending/splitpay/freelancer-credit-line/freelancercreditlineweb.v1.applications.showoperation.md): Returns the current status and details of an existing freelancer credit line application. ### Link credit record to freelancer credit line application - [PUT /v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}/credit_record](https://docs.solarisgroup.com/api-reference/lending/splitpay/freelancer-credit-line/freelancercreditlineweb.v1.applications.linkcreditrecordoperation.md): Links a freelancer credit record to their existing credit line application. You have to add the unique ID of the credit record in the payload of this endpoint. ### Link account snapshot to freelancer credit line application - [PUT /v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}/account_snapshot](https://docs.solarisgroup.com/api-reference/lending/splitpay/freelancer-credit-line/freelancercreditlineweb.v1.applications.linkaccountsnapshotoperation.md): Links a freelancer account snapshot to their existing credit line application. You have to add the unique ID of the account snapshot in the payload of this endpoint. ### Set contract agreement date for a freelancer credit line application - [PUT /v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}/contract_agreement](https://docs.solarisgroup.com/api-reference/lending/splitpay/freelancer-credit-line/freelancercreditlineweb.v1.applications.setcontractagreementoperation.md): Creates the credit line contract agreement. After a credit application passes the credit checks, call this endpoint and collect the customer's consent on the credit line contract and terms and conditions.