Skip to main content

​
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, this is where you should start.

​
1: Installation Guide

Manually install Blnk on your own infrastructure. This option requires Docker and Docker Compose.
1

Install prerequisites

Make sure you have Docker and Compose installed and running on your machine.
2

Clone the repository

Clone the Blnk repository into your machine:
bash
git clone https://github.com/blnkfinance/blnk && cd blnk
3

Create configuration file

Create a configuration file, blnk.json:
bash
touch blnk.json
4

Configure Blnk

Copy and save the following configuration:
blnk.json
{
  "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"
  }
}
5

Start Blnk server

Start your Blnk server with Docker compose:
bash
docker compose up
Your Blnk server is now running! You can verify it’s working by visiting http://localhost:5001 in your browser.

​
2: Create your first transaction

Now that Blnk is running, let’s create your first transaction. Blnk uses the double entry principle to record transactions, which means every transaction must have a source and destination. 
curl -X POST 'http://localhost:5001/transactions' \
  -H 'X-blnk-key: <api-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": {}
  }'
Congratulations! You’ve successfully created your first transaction in Blnk.
Finally, let’s view our balances to confirm that the transaction was recorded: 
curl -X GET 'http://localhost:5001/balances'
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.
To learn more about navigating your ledger, see our Blnk Cloud guide.
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:

Ledgers

Organize your ledger according to your business/application needs.

Balances

Create and manage balances for wallets, accounts, and any store of value.

Transactions

Create any transaction workflow with Blnk.

Identities

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 or join our Discord community.
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 →