Getting Started

Welcome to ZyPay SDK

Start integrating seamless payment processing into your application with our powerful SDK. Get up and running in minutes.

Quick Start

1

Install the SDK

Install the ZyPay SDK using your preferred package manager:

npm
npm install @zypay/sdk
yarn
yarn add @zypay/sdk
pnpm
pnpm add @zypay/sdk
2

Initialize the Client

Create a new ZyPay client with your API credentials:

JavaScript/TypeScript
import { ZyPaySDK } from '@zypay/sdk'

const client = new ZyPaySDK({
  apiKey: 'your_api_key_here',
  environment: 'sandbox', // or 'production'
  webhookSecret: 'your_webhook_secret' // optional
})

// Test the connection
const health = await client.health.check()
console.log('SDK Status:', health.status)
3

Make Your First Payment

Process a simple payment with just a few lines of code:

Create Payment
// Create a new payment
const payment = await client.payments.create({
  amount: {
    value: 1000, // $10.00 in cents
    currency: 'USD'
  },
  customer: {
    email: 'customer@example.com',
    firstName: 'John',
    lastName: 'Doe'
  },
  description: 'Test payment',
  metadata: {
    orderId: 'order_123',
    source: 'website'
  }
})

console.log('Payment created:', payment.id)
console.log('Status:', payment.status)

// Handle payment completion
if (payment.status === 'completed') {
  console.log('Payment successful!')
}

What's Next?

API Reference

Complete documentation of all available methods, parameters, and responses

Explore APIs

Webhooks

Set up real-time notifications for payment events and status changes

Configure Webhooks

Examples

Ready-to-use code snippets and integration examples for common scenarios

View Examples

Choose Your Integration

Web Integration

JavaScript SDK and payment forms

Integrate payments directly into your web application with our JavaScript SDK

Get Started

Mobile SDKs

iOS and Android integration

Native mobile SDKs for iOS and Android applications

Get Started

Server SDKs

Backend integration libraries

Server-side SDKs for Node.js, Python, PHP, Java, and more

Get Started

SDK Features

TypeScript Support

Full TypeScript definitions for better development experience

Error Handling

Comprehensive error handling with detailed error messages

Retry Logic

Automatic retry for failed requests with exponential backoff

Webhook Verification

Built-in webhook signature verification for security