Overview - Corsair

Use Fidel through Corsair: one client, typed API calls. The API key is your Fidel secret key (sk_test_… or sk_live_…). A test key only sees test data. List operations return up to limit items (100 by default). When a response has a last cursor there is another page: pass JSON.stringify(last) as start on the next call. On mid-insights.listMidInsights the cursor is already a string, so pass it unchanged. The plugin does not link cards. Cards are linked with Fidel’s own SDKs, which keep card numbers off your servers, and the plugin works with cards once they are linked. What you get:

55 typed API operations

Setup

Install

npm install corsair @corsair-dev/fidel better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/fidel better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/fidel better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/fidel better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { fidel } from '@corsair-dev/fidel';

export const corsair = createCorsair({
	plugins: [
		fidel(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

fidel()

More: API Key

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'fidel',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

List programs

const tenant = corsair.withTenant('acme');
await tenant.fidel.api.programs.listPrograms({});

Create a brand

const tenant = corsair.withTenant('acme');
await tenant.fidel.api.brands.createBrand({ name: 'Acme Coffee' });

See the full list on the API page.

What’s next

API reference

Every fidel.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​What’s next