Betalink Docs

Installation

Install the Betalink API client using your preferred package manager:

npm install @betalink/api-client

Configuration

Create a client instance with your API credentials:

import { createBetalinkClient } from "@betalink/api-client";

const client = createBetalinkClient({
  baseUrl: "https://betalink.dev/api",
  apiKey: "your-api-key",
  timeout: 30000, // optional, defaults to 30 seconds
});

Configuration Options

Option	Type	Required	Default	Description
`baseUrl`	`string`	Yes	-	The Betalink API base URL
`apiKey`	`string`	Yes	-	Your API key for authentication
`timeout`	`number`	No	`30000`	Request timeout in milliseconds

Basic Usage

List Companies

Retrieve a paginated list of companies:

const response = await client.listCompanies();

console.log(`Total companies: ${response.meta.total}`);

for (const company of response.data) {
  console.log(`${company.cvr}: ${company.name}`);
}

Get a Single Company

Fetch a company by its CVR number:

const company = await client.getCompany("12345678");

console.log(`Company: ${company.name}`);
console.log(`Status: ${company.status}`);
console.log(`Address: ${company.address}`);

Get Company Transactions

Retrieve transactions for a specific company:

const transactions = await client.getCompanyTransactions("12345678");

for (const tx of transactions.data) {
  console.log(`${tx.dispositionDate}: ${tx.amountDkk} DKK`);
}

Health Check

Verify the API is operational:

const health = await client.health();
console.log(`API Status: ${health.status}`); // "ok"

TypeScript Support

The client is fully typed with TypeScript. All responses include proper type definitions:

import type {
  Company,
  Transaction,
  CompaniesResponse,
  TransactionsResponse,
} from "@betalink/api-client";

// Types are inferred automatically
const companies: CompaniesResponse = await client.listCompanies();
const company: Company = await client.getCompany("12345678");