Guides

Kyshi MoR SDK

The Kyshi MoR SDK is the official TypeScript and Node.js package for integrating with Kyshi MoR external APIs.

Use the SDK when you want typed resource methods, consistent error handling, request timeouts, retries, idempotency support, and webhook signature helpers without writing raw HTTP calls for every endpoint.

This is a separate documentation section from the API guides and API Reference. Integrators can use these pages to learn the SDK flow, then use the API Reference only when they need exact endpoint schemas or raw HTTP details.

Who This Is For

This SDK is for backend developers integrating Kyshi MoR from JavaScript or TypeScript applications.

The SDK supports:

  • Node.js backend services
  • TypeScript applications
  • JavaScript applications
  • Serverless functions that run on a Node.js-compatible runtime

Do not use your Kyshi secret key directly in browser JavaScript, mobile apps, or other customer-facing environments.

What The SDK Covers

The SDK includes resource modules for:

  • Transactions
  • Payment links
  • General payment links
  • Transfers
  • Virtual accounts
  • Virtual account transfers
  • Plans
  • Subscriptions
  • Rates and custom rates
  • Webhook verification and webhook operations

SDK Or Raw API

Use the SDK for normal application integrations. Use the API Reference when you need exact endpoint schemas, request fields, generated cURL examples, or routes that are not yet wrapped by the SDK.

The SDK also exposes a low-level client, so you can call unwrapped routes without leaving the package.

const response = await kyshi.client.get('transactions/history', {
  query: { page: 1, limit: 10 },
});

Current Package

npm install @kyshi/mor-sdk

The first public release is 0.1.0-beta.0. During beta, install with the beta tag if your package manager does not resolve prereleases automatically:

npm install @kyshi/mor-sdk@beta

Other Languages

This release documents the Node.js and TypeScript SDK. Python, PHP, Java, Go, or other language SDKs should be released and documented as separate packages when they are available. They are not created automatically by publishing the Node.js SDK.