> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Getting Started with Blnk
> The developer-first toolkit for building compliant financial products.
## Overview
This is your guide to getting started with Blnk, pronounced as `/blank/`. If you are new to Blnk or [open-source fintech developer tools](https://blnkfinance.com), this is where you should start.
***
## 1: Installation Guide
Manually install Blnk on your own infrastructure. This option requires Docker and Docker Compose.
Make sure you have [Docker](https://www.docker.com/) and [Compose](https://docs.docker.com/compose/) installed and running on your machine.
Clone the Blnk repository into your machine:
```bash bash theme={"system"}
git clone https://github.com/blnkfinance/blnk && cd blnk
```
Create a configuration file, `blnk.json`:
```bash bash theme={"system"}
touch blnk.json
```
Copy and save the following configuration:
```json blnk.json theme={"system"}
{
"project_name": "Blnk",
"data_source": {
"dns": "postgres://postgres:password@postgres:5432/blnk?sslmode=disable"
},
"redis": {
"dns": "redis:6379"
},
"typesense": {
"dns": "http://typesense:8108"
},
"server": {
"port": "5001"
}
}
```
Start your Blnk server with Docker compose:
```bash bash theme={"system"}
docker compose up
```
Your Blnk server is now running! You can verify it's working by visiting `http://localhost:5001` in your browser.
Get started quickly with Blnk's managed cloud hosting. No infrastructure setup required—just sign up and start building.
If you don't have a Blnk Cloud account yet, sign up at [cloud.blnkfinance.com](https://cloud.blnkfinance.com) to create your workspace.
On the homepage, click on **Deploy new Core**.
Choose a descriptive name for your instance (e.g., "Production", "Staging"). Next, click on **Deploy managed Core**.
It takes about 7-10 minutes to deploy your instance and get it ready for use.
When it is ready, the connection status is updated to **Connected** and you can start using your instance.
Your Blnk instance is now running! View the instance details to get your Core URL and secret key for making requests via the Core API.
***
## 2: Create your first transaction
Now that Blnk is running, let's create your first transaction. Blnk uses the [double entry principle](/guides/double-entry) to record transactions, which means every transaction must have a source and destination.
```bash cURL theme={"system"}
curl -X POST 'http://localhost:5001/transactions' \
-H 'X-blnk-key: ' \
-H 'Content-Type: application/json' \
-d '{
"amount": 1000,
"reference": "first_transaction_001",
"currency": "USD",
"precision": 100,
"source": "@FundingPool",
"destination": "@MyBalance",
"description": "My first Blnk transaction",
"allow_overdraft": true,
"meta_data": {}
}'
```
```json Response theme={"system"}
{
"id": "txn_6164573b-6cc8-45a4-ad2e-7b4ba6a60f7d",
"source": "@FundingPool",
"destination": "@MyBalance",
"reference": "first_transaction_001",
"amount": 1000,
"precision": 100,
"precise_amount": 100000,
"currency": "USD",
"description": "My first Blnk transaction",
"allow_overdraft": true,
"status": "QUEUED",
"created_at": "2024-12-21T01:36:46.997063436Z",
"meta_data": {}
}
```
Congratulations! You've successfully created your first transaction in Blnk.
Finally, let's view our balances to confirm that the transaction was recorded:
```bash cURL theme={"system"}
curl -X GET 'http://localhost:5001/balances'
```
```json Response theme={"system"}
{
"balances": [
{
"balance": -1000,
"version": 1,
"inflight_balance": 0,
"credit_balance": 0,
"inflight_credit_balance": 0,
"debit_balance": 1000,
"inflight_debit_balance": 0,
"queued_credit_balance": 0,
"queued_debit_balance": 0,
"precision": 100,
"ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"identity_id": "",
"balance_id": "bln_ebcd230f-6265-4d4a-a4ca-45974c47f746",
"indicator": "@FundingPool",
"currency": "USD",
"created_at": "2024-12-21T01:36:46.997063436Z",
"meta_data": null
},
{
"balance": 1000,
"version": 1,
"inflight_balance": 0,
"credit_balance": 1000,
"inflight_credit_balance": 0,
"debit_balance": 0,
"inflight_debit_balance": 0,
"queued_credit_balance": 0,
"queued_debit_balance": 0,
"precision": 100,
"ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"identity_id": "",
"balance_id": "bln_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"indicator": "@MyBalance",
"currency": "USD",
"created_at": "2024-12-21T01:36:46.997063436Z",
"meta_data": null
}
]
}
```
This will return a list of all balances in your system. You should see the `@FundingPool` balance (which will be negative since it funded the transaction) and the `@MyBalance` balance (which will show the amount we transferred).
***
## 3: View your ledger (optional)
See your new balances and transaction in your [Blnk Cloud dashboard](https://cloud.blnkfinance.com).
To learn more about navigating your ledger, see our [Blnk Cloud guide.](https://guide.cloud.blnkfinance.com)
> You've successfully completed the Blnk getting started guide! You now have a working Blnk instance with your first transaction recorded.
***
## Key concepts
Now that you're set up, start with these key concepts to build your application:
Organize your ledger according to your business/application needs.
Create and manage balances for wallets, accounts, and any store of value.
Create any transaction workflow with Blnk.
Create, manage and link identities securely to balances.
***
## Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.
To ask questions or discuss issues, please [contact us](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).
***
**Tip:** Connect to Blnk Cloud to see your Core data.
You can view your transactions, manage identities, create custom reports, invite other team members to collaborate, and perform operations on your Core — all in one dashboard.
[Check out Blnk Cloud →](https://www.blnkfinance.com/products/cloud)
***
## 1: Installation Guide