Gift Up! plugin

Use Gift Up! through Corsair: one client, typed API calls. Gift Up! is a digital and physical gift card platform. The REST API operates under https://api.giftup.app. Authentication requires an API key passed via the Authorization: Bearer <api_key> header. API keys are generated in the Gift Up! dashboard under Settings > Integrations > API. Key concepts:

Orders and Gift Card Issuance: Gift cards are created by placing an order via orders.create.
Redemptions: Full or partial redemptions are performed on the gift card resource via giftCards.redeem or giftCards.redeemInFull. Redemptions can be reversed/refunded using giftCards.undoRedemption.
JSON Patch: Updates to gift cards, orders, items, groups, users, and settings use RFC 6902 JSON Patch operations.
Test Mode: Set testMode: true in the plugin options to send the x-giftup-testmode: true header, so calls use the account’s test data. In live mode, orders.create is charged Gift Up’s fee.
Emails: orders.create emails the gift card when recipientDetails is set, unless disableAllEmails is true. users.invite emails an invitation.
Lists: giftCards.list, orders.list and reports.listTransactions return { <items>, total, hasMore }; page with limit (max 100) and offset.

What you get:

51 typed API operations

Setup

Install

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

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

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

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

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		giftup(),
	],
	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)

Store the Gift Up! API key before the first call: pnpm corsair setup --plugin=giftup --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.

giftup()

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: 'giftup',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

company.get

const tenant = corsair.withTenant('acme');
await tenant.giftup.api.company.get({});

giftCards.reactivate

const tenant = corsair.withTenant('acme');
await tenant.giftup.api.giftCards.reactivate({});

See the full list on the API page.

What’s next

API reference

Every giftup.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.

Overview

Plugins