Skip to content

Quickstart

  • Node.js 22 or newer.
  • A Minmo Partner ID and Partner API key with the permissions your integration needs.
  • A server-side TypeScript project.

Create the key in Console’s API-key management area. Store MINMO_PARTNER_ID and MINMO_API_KEY in your server environment or secrets manager.

Terminal window
npm install @minmoto/sdk@0.3.0
import { MinmoClient } from "@minmoto/sdk";
const minmo = new MinmoClient({
partnerId: process.env.MINMO_PARTNER_ID!,
apiKey: process.env.MINMO_API_KEY!,
});
const partner = await minmo.account.get();
console.log(`Connected to ${partner.displayName}`);

This reads the Partner account without creating a payment or moving funds. The SDK uses the production service by default. Supply baseUrl only when connecting to another Minmo deployment with matching credentials.

Read authentication, choose a resource from capabilities, and use events to react to changes.