> ## 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.
# Quick Start
> Install the TypeScript SDK and create your first transaction.
export const CtaCallout = props => {
const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
const handleCtaClick = () => {
if (typeof window === "undefined" || !trackingEvent) {
return;
}
try {
window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
detail: {
name: trackingEvent,
href
}
}));
} catch {}
try {
window.posthog?.capture?.(trackingEvent, {
href
});
} catch {}
const gaPayload = {
cta_href: href
};
try {
window.gtag?.("event", trackingEvent, gaPayload);
} catch {}
try {
window.dataLayer = window.dataLayer || [];
window.dataLayer.push({
event: trackingEvent,
...gaPayload
});
} catch {}
};
const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
const linkRel = isExternal ? rel : undefined;
return ;
};
This guide walks you through installing the Blnk TypeScript SDK, initializing the client, and creating your first ledger resource.
By the end, you'll have a working connection to Blnk and be ready to build financial products from your TypeScript or JavaScript application.
Install the SDK in your project. v1.2.0 and later require Node.js 18 or later.
```bash wrap theme={"system"}
npm install @blnkfinance/blnk-typescript
```
Create an `index.js` file as shown below to create your first transaction with the SDK.
Make sure you have a running Blnk Core instance. Set the URL and API key as environment variables in your project.
```javascript index.js wrap theme={"system"}
const { BlnkInit } = require('@blnkfinance/blnk-typescript');
const blnk = BlnkInit(process.env.BLNK_API_KEY ?? '', {
baseUrl: process.env.BLNK_BASE_URL ?? 'http://localhost:5001',
});
async function main() {
const response = await blnk.Transactions.create({
precise_amount: 100000,
reference: 'first_txn_001',
currency: 'USD',
precision: 100,
source: '@FundingPool',
destination: '@MyBalance',
description: 'My first Blnk transaction',
allow_overdraft: true,
});
if (response.status !== 201 || !response.data) {
throw new Error(response.message);
}
console.log(JSON.stringify(response.data, null, 2));
}
main();
```
Run the file.
```bash wrap theme={"system"}
node index.js
```
You should get the following response:
```json 201 Created wrap expandable theme={"system"}
{
"amount": 1000,
"rate": 0,
"precision": 100,
"precise_amount": 100000,
"transaction_id": "txn_8d2ce2f0-0d75-4a91-9d43-2ad2c2e6b9ad",
"parent_transaction": "",
"source": "bln_f344b673-e855-4bda-b769-3e94a02c1941",
"destination": "bln_d5cbde84-d20a-485b-8ce8-6677d782c3a1",
"reference": "first_txn_001",
"currency": "USD",
"description": "My first Blnk transaction",
"status": "QUEUED",
"hash": "0b9c25fb5b00d6c71cb4ca87026bf6dc316e63353d3330deb588bd0b3d74dcc0",
"allow_overdraft": true,
"inflight": false,
"created_at": "2024-11-26T09:33:35.265582042Z",
"scheduled_for": "0001-01-01T00:00:00Z",
"inflight_expiry_date": "0001-01-01T00:00:00Z",
"inflight_commit_date": "0001-01-01T00:00:00Z"
}
```
Confirm the transaction landed in your ledger.
1. Open **Transactions** in the sidebar.
2. Find your transaction by reference (`first_txn_001`) or by the `transaction_id` from the script output.
3. Click the row to open the details and verify the amount, status, source, and destination.
If the transaction is missing, click **Refresh** on the table to pull the latest data from Core.
Fetch the transaction by ID:
```bash wrap theme={"system"}
blnk transactions list --id txn_8d2ce2f0-0d75-4a91-9d43-2ad2c2e6b9ad
```
Replace the transaction ID with the value printed by your script.
***
## Related docs
Authentication, timeouts, retries, and logging.
ApiResponse checks and Core error bodies.
TypeScript SDK releases and version history.
***
## 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).
Sign up and manage your ledger with our back-office dashboard. You can invite teammates to collaborate and manage your ledger operations directly from the dashboard.