Skip to main content

Installation

Install Packages​

npm install @zkp2p/pay-sdk
# optional: shared types only
npm install @zkp2p/pay-shared

Importing​

import {
  createCheckout,
  getCheckoutUrl,
  redirectToCheckout,
} from '@zkp2p/pay-sdk';

CommonJS users can dynamic import:

const { createCheckout } = await import('@zkp2p/pay-sdk');

TypeScript​

import type {
  CheckoutClientOptions,
  CreateOrderRequest,
  CheckoutOrder,
  WebhookPayload,
} from '@zkp2p/pay-sdk';

const options: CheckoutClientOptions = {
  apiBaseUrl: 'https://api.pay.peer.xyz',
  checkoutBaseUrl: 'https://pay.peer.xyz',
  apiKey: process.env.ZKPAY_API_KEY,
};

const request: CreateOrderRequest = {
  requestedUsdcAmount: '50.00',
  destinationChainId: 8453,
  destinationToken: 'USDC',
  successUrl: null,
  cancelUrl: null,
  notes: null,
};

Runtime Requirements​

  • Node.js 18+
  • Browser/runtime with fetch

Security​

Create orders from your backend and keep API keys server-side.