> For the complete documentation index, see [llms.txt](https://docs.xyb.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xyb.co/credit/getting-started/xyb-credit-quick-start-guide.md).

# XYB Credit - Quick Start Guide

Designing a credit product on the platform involves a layered approach that builds flexibility, control, and reuse into your credit lifecycle. This structure ensures that you define reusable building blocks once, then assemble them to create purpose-specific products, and finally deploy those products at a customer level through contracts. Below is a detailed breakdown of how this works across **three levels**:

### **Level 1: Service Configuration: Define the Rules**

This foundational layer focuses on configuring reusable logic that will later power multiple products. Think of this as defining your **global settings** for credit. Read below the services you will need to configure or directly jump into [Configure Global Settings for Credit Products ](/credit/configure-and-create-credit-products/configure-global-settings-for-credit-products.md)to get started.

#### Key Services You Configure:

1. **Entity Service**\
   Define sectors, segments, custom fields, and supported currencies. This ensures every entity (e.g. customers, partners) is correctly profiled for downstream credit use. [Learn more](/credit/create-and-manage-contracts/manage-entities-for-credit-products.md).
2. **Collateral Service**\
   Configure collateral types like `CASH`, `IMMOVABLE`, and their subtypes. These definitions are referenced later when assigning guarantees to contracts. [Learn more](/credit/configure-and-create-credit-products/configure-global-settings-for-credit-products/configure-and-create-collaterals.md)
3. **Interest Service**\
   Set up interest categories such as `PRINCIPAL`, `PENALTY`, and `COMMITMENT`, with types like flat, reducing balance, or variable. These settings ensure consistency in interest logic across products. [Learn more](/credit/configure-and-create-credit-products/configure-global-settings-for-credit-products/configure-interest-service.md)
4. **Contract Service**\
   Define defaults for repayment terms, schedule types (e.g., `ANNUITY`, `BULLET`, `BALLOON`), component settlement orders, customer applicability, and more. This helps encapsulate how a typical credit agreement behaves. [Learn more](/credit/configure-and-create-credit-products/configure-global-settings-for-credit-products/configure-credit-contract-service-attributes.md)
5. **Product Configuration Service**\
   Configure product states, transitions, and permissible workflows like activation, suspension, or termination. [Learn more](/credit/configure-and-create-credit-products/configure-global-settings-for-credit-products.md)

Once these services are configured, they act as global libraries that can be selectively applied to specific product versions.

***

### **Level 2: Product Configuration: Assemble the Use Case**

After setting up services, you move to the **Product Configuration** tab to create actual credit product definitions like **Small Business Loans** or **BNPL Pay Later**. These are version-controlled containers where you link services configured at Level 1.

#### Steps to Configure a Credit Product:

1. **Create New Product**\
   Define a name, unique product reference, and version.
2. **Add Services to Product**\
   Select from the configured services: Ledger, Product Config, Accounts, Credit Contracts, etc.
3. **Credit Product Setup**\
   You now see all options pulled from Level 1:
   * Choose **owner** and **length type**
   * Set first principal and interest repayment periods
   * Select settlement order and schedule type (`FIXED`, `ANNUITY`, etc.)
   * Define customer applicability (sector and segment)
   * Choose currencies, interest types, and agreement length attributes
4. **Templates and Collateral**\
   Link to predefined templates like `CreditAgreementTemplate`, and assign collateral types if required.

This stage is where the credit **product logic becomes concrete** you define exactly how the loan or credit behaves for a specific use case. [Learn more](/credit/create-a-credit-contract-product.md)

***

### **Level 3: Contract Disbursal and Manage Repayment**

With the credit product now fully configured and activated, you can move to the **Contracts > Lending** section and start creating individual customer contracts.

#### How This Works:

* Select the product (e.g. Small Business Loans)
* Choose the linked entity (customer, partner, etc.)
* Auto-fill terms and interest based on product version
* Assign collateral if applicable
* Generate the contract document using the linked template
* Activate and monitor repayments via the ledger and payments tab

This level is where business teams operate daily creating actual agreements tied to real-world borrowers. Learn more about [Disbursing & Managing Credit Contracts](/credit/disburse-and-manage-credit-contracts.md).

<br>

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xyb.co/credit/getting-started/xyb-credit-quick-start-guide.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.