Wallet API

RESTful API for developers to integrate Cyber Guardians wallet functionality into mobile apps and third-party platforms

Get Started View Endpoints

API Overview

Secure, scalable, and developer-friendly wallet integration

Base URL

https://cyberguardians.com/fintech/api/v1

Authentication

Bearer Token (JWT)

Data Format

JSON

Rate Limit

1000 requests/hour

Authentication

All API requests require authentication using Bearer tokens. Include the token in the Authorization header:

Request Headers

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Getting API Keys

1 Register for a Cyber Guardians account
2 Navigate to Developer Dashboard
3 Create a new application
4 Generate your API keys

Security Best Practices

Never expose API keys in client-side code
Use HTTPS for all API requests
Rotate API keys regularly
Implement proper error handling

API Endpoints

Complete list of available wallet API endpoints

Get Wallet Balance

GET

Retrieve the current balance for all user wallets

GET /wallet/balance

Response Example

{
  "success": true,
  "data": {
    "wallets": [
      {
        "currency": "PKR",
        "balance": 50000.00,
        "frozen_balance": 0.00,
        "available_balance": 50000.00
      },
      {
        "currency": "USD",
        "balance": 250.00,
        "frozen_balance": 50.00,
        "available_balance": 200.00
      }
    ],
    "total_balance_pkr": 125000.00
  }
}

Send Money

POST

Transfer funds to another user's wallet

POST /wallet/transfer

Request Body

{
  "recipient_email": "user@example.com",
  "amount": 5000.00,
  "currency": "PKR",
  "description": "Payment for services"
}

Response Example

{
  "success": true,
  "data": {
    "transaction_id": "TXN_123456789",
    "status": "completed",
    "amount": 5000.00,
    "currency": "PKR",
    "recipient": "user@example.com"
  }
}

Transaction History

GET

Get transaction history with pagination and filtering

GET /wallet/transactions?page=1&limit=20&type=all

Query Parameters

page - Page number (default: 1)
limit - Results per page (default: 20)
type - Transaction type (all, send, receive)
start_date - Filter by start date
end_date - Filter by end date

Create Escrow

POST

Create a new escrow transaction for secure payments

POST /escrow/create

Request Body

{
  "buyer_email": "buyer@example.com",
  "seller_email": "seller@example.com",
  "amount": 25000.00,
  "currency": "PKR",
  "description": "Product purchase",
  "milestones": 3
}

Error Codes

200 Success

Request completed successfully

400 Bad Request

Invalid request parameters

401 Unauthorized

Invalid or missing API key

403 Forbidden

Insufficient permissions

404 Not Found

Resource not found

429 Rate Limited

Too many requests

SDK & Libraries

Official SDKs for popular programming languages

JavaScript

Node.js & Browser

npm install @cyberguardians/wallet-api

Python

Python 3.7+

pip install cyberguardians-wallet

PHP

PHP 7.4+

composer require cyberguardians/wallet

Mobile

iOS & Android

Coming Soon

Need Help?

Our developer support team is here to help you integrate the Wallet API into your applications

Email Support API Documentation