Skip to content

SDK Installation

Install

bash
npm install @payre/sdk
# or
pnpm add @payre/sdk
# or
yarn add @payre/sdk

Setup

typescript
import { PayreClient } from '@payre/sdk';

const payre = new PayreClient({
  apiKey: 'pyr_sk_your_api_key',
  baseUrl: 'http://localhost:3000', // optional
});

Configuration

OptionTypeDefaultDescription
apiKeystring(required)Your Payre API key
baseUrlstringhttp://localhost:3000API server URL

Environment Variables

The SDK also reads from environment variables (used by the CLI):

  • PAYRE_API_KEY — API key
  • PAYRE_BASE_URL — API server URL