> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Polygon OMS plugin

> Polygon Open Money Stack (OMS) payments API for moving money between crypto and fiat, with quotes, transfers, wallets, customers and webhooks.

Use **Polygon OMS** through Corsair: one client, typed API calls.

Polygon OMS takes a key and secret pair and mints a 60-minute bearer token from them, and the plugin does the exchange for you. Create a project and an API key in the OMS dashboard, then copy the secret at creation time, because OMS shows it once and stores only a hash. Both values are stored on the account: the key as `api_key` and the secret as `api_secret`. The key picks the host: `sk_sdbx_` keys go to the sandbox, which simulates every transfer, and `sk_live_` keys to production. Set `environment` in the plugin options to override it.

Things to know before money moves:

* **Two steps, not one.** `quotes.create` prices a transfer and locks the rate for a few minutes. `transactions.create` accepts that quote and starts the transfer. Nothing moves until the second call, which is why the plugin marks the quote a write and the transaction destructive.
* **One amount, one side.** Set the amount on the source or the destination, never both: OMS calculates the other side. The plugin rejects a call that sets both or neither before it is sent.
* **Idempotency.** OMS requires an `Idempotency-Key` header on every non-auth POST. The plugin generates one per call; pass `idempotencyKey` in the input to reuse it, which is what makes a retried transfer the same attempt rather than a second one.
* **Personal data is write-only.** A customer accepts `birthDate`, `residentialAddress`, `ipAddress` and identifying documents, and OMS never returns them. Reads show the onboarding `status` and, when something is outstanding, a `hold`.
* **Networks are names, not numbers.** Pass `polygon` or `ethereum`; OMS rejects the numeric chain ids. `networks.list` reports what this project can actually route.
* **Balances can be negative.** `wallets.balance` mirrors the provider, so a clawback after funds were spent reads as a negative string.
* **Webhooks.** The plugin registers, reads, updates and deletes OMS webhook endpoints, including the one-time HMAC signing key from `webhooks.create`. It does not handle inbound deliveries.

**What you get:**

* 21 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/polygon better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/polygon better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/polygon better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/polygon better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { polygon } from '@corsair-dev/polygon';

export const corsair = createCorsair({
	plugins: [
		polygon(),
	],
	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](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Polygon OMS API key before the first call: `pnpm corsair setup --plugin=polygon --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](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> polygon()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. 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](https://docs.corsair.dev/management/connect).

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

## Example API calls

**List the networks this project can route**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.polygon.api.networks.list({ limit: 20 });
```

**Price a USDC to USD bank payout**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.polygon.api.quotes.create({
	customerId: 'cst_vfa0nxw6zvyws9g237jrxn4y7k',
	source: {
		type: 'walletCrypto',
		details: { id: 'wlt_5h4jzzpr9xre3bamd9ca7qyghn', asset: 'usdc', network: 'polygon' },
		amount: '100.00',
	},
	destination: {
		type: 'bankUs',
		details: { id: 'ext_fky491gakzj0dd46qb6whsr2vq', asset: 'usd', network: 'ach' },
	},
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/polygon/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/polygon/api.md)
>
> Every `polygon.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.