ZyPayDocs
API Reference

ZyPay API Reference

Complete documentation for all ZyPay APIs. Build powerful payment solutions with our RESTful APIs and comprehensive developer tools.

API Overview

Payments API

Process payments and transactions

Create, retrieve, and manage payments with our comprehensive Payments API

View Documentation

Customers API

Manage customer data

Create and manage customer profiles, payment methods, and preferences

View Documentation

Refunds API

Process refunds and voids

Handle refunds, partial refunds, and payment voids with ease

View Documentation

Webhooks API

Real-time event notifications

Set up and manage webhooks for real-time payment event notifications

View Documentation

Security API

Authentication and security

Manage API keys, authentication, and security configurations

View Documentation

Analytics API

Payment analytics and reporting

Access payment analytics, reports, and business insights

View Documentation

Authentication

API Key Authentication

All API requests require authentication using your API key

Include your API key in the Authorization header of all requests:

cURL Example
curl -X GET https://api.zypay.com/v1/payments \
  -H "Authorization: Bearer sk_test_1234567890abcdef" \
  -H "Content-Type: application/json"

Test Environment

Use test API keys (starting with sk_test_) for development and testing

Production Environment

Use live API keys (starting with sk_live_) for production

API Endpoints

Create Payment

Create a new payment

POST
/v1/payments
Request
{
  "amount": {
    "value": 1000,
    "currency": "USD"
  },
  "customer": {
    "email": "customer@example.com",
    "firstName": "John",
    "lastName": "Doe"
  },
  "description": "Test payment",
  "metadata": {
    "orderId": "order_123"
  }
}
Response
{
  "id": "pay_1234567890",
  "status": "pending",
  "amount": {
    "value": 1000,
    "currency": "USD"
  },
  "customer": {
    "id": "cust_1234567890",
    "email": "customer@example.com",
    "firstName": "John",
    "lastName": "Doe"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Error Handling

HTTP Status Codes

ZyPay uses standard HTTP status codes to indicate success or failure

2xx Success

Request was successful

4xx Client Error

Request was invalid or unauthorized

5xx Server Error

Internal server error occurred

429 Rate Limited

Too many requests, please retry later

Rate Limits

API Rate Limits

ZyPay enforces rate limits to ensure fair usage and system stability

Free Tier

100

requests per minute

Pro Tier

1,000

requests per minute

Enterprise

10,000

requests per minute

Official SDKs

JavaScript

v2.1.0

npm install @zypay/sdk

Python

v1.8.0

pip install zypay

PHP

v3.2.0

composer require zypay/zypay-php

Java

v2.0.0

implementation 'com.zypay:zypay-java:2.0.0'

Ready to Start Building?

Explore our comprehensive API documentation and start integrating payments into your application today.

Get StartedTry API Explorer