API v1.0

Build Payment Solutions with HooPay API

Integrate payments and collections into your platform with our secure, well-documented REST API. Start building in minutes.

Pay User
# Partner pays money to user wallet
curl -X POST https://hoopaywallet.com/api/v1/partner/pay-user \
  -H "Content-Type: application/json" \
  -H "X-API-Key: hpk_sandbox_..." \
  -H "X-Signature: your_hmac_signature" \
  -d '{
    "reference_id": "DEP-001",
    "user_wallet_id": "123456",
    "amount": "100.00",
    "currency": "USD",
    "description": "Trading payout"
  }'

Core APIs

Everything you need to pay users, collect from users, and manage transactions.

Pay User API

Partner pays money to user wallets. Perfect for payouts, rewards, and fund transfers from your platform.

Instant Idempotent Webhooks
View Documentation

Collect From User API

Partner collects money from user HooPay wallets with secure user authorization. Great for trading platforms.

User Auth Redirect Flow Webhooks
View Documentation

Additional APIs

Supporting APIs for complete integration

Wallet Verification

Verify wallet IDs before transactions

Learn More →

Refunds API

Reverse payments or failed collections

Learn More →

Fees API

Get fee schedules and calculate fees

Learn More →

Webhooks

Real-time event notifications

Learn More →

How to Get Started

Follow these steps to become a HooPay partner and start integrating.

1

Register with HooPay Required

Contact our business development team to register as a partner. We'll review your application and set up your partner account.

Contact Information

Email: info@hoopaywallet.com

We'll guide you through the registration process and answer any questions.

2

Get Your API Keys

Once approved, you'll receive your API credentials through the partner dashboard. You'll get separate keys for sandbox (testing) and production (live) environments.

# Sandbox credentials (for testing) API_KEY="hpk_sandbox_..." API_SECRET="hps_sandbox_..." # Production credentials (for live transactions) API_KEY="hpk_prod_..." API_SECRET="hps_prod_..."

Important: Store your API secret securely. It's shown only once during generation and is used for HMAC signature generation.

3

Start Testing with Sandbox

Use your sandbox API keys to test integrations safely. The sandbox environment uses the same API endpoint as production but processes test transactions.

✅ Sandbox Testing

Use sandbox keys for development and testing. No real money involved.

⚠️ Production Keys

Only use production keys after thorough testing. Real transactions occur.

# API Base URL (same for sandbox and production)
BASE_URL="https://hoopaywallet.com/api/v1/partner"

# Example: Pay User endpoint
POST /pay-user
POST /collect-from-user
4

Generate HMAC Signatures

Sign your requests with HMAC-SHA256 using your API secret. Use our API Playground to test signature generation.

# Python example
import hmac, hashlib, json

def sign_request(payload, secret):
    # Sort keys alphabetically (recursive)
    canonical = json.dumps(payload, separators=(',', ':'), sort_keys=True)
    # Generate HMAC-SHA256 signature
    return hmac.new(
        secret.encode(),
        canonical.encode(),
        hashlib.sha256
    ).hexdigest()
5

Make Your First API Call

Test the Pay User API to deposit money into a user wallet.

# Example: Pay User request
curl -X POST https://hoopaywallet.com/api/v1/partner/pay-user \
  -H "Content-Type: application/json" \
  -H "X-API-Key: hpk_sandbox_..." \
  -H "X-Signature: your_hmac_signature" \
  -d '{
    "reference_id": "DEP-001",
    "user_wallet_id": "123456",
    "amount": "100.00",
    "currency": "USD",
    "description": "Test payment"
  }'

# Response
{
  "success": true,
  "data": {
    "deposit_id": "dep_abc123xyz789",
    "reference_id": "DEP-001",
    "status": "completed",
    "amount": 100.00
  }
}
6

Set Up Webhooks

Configure webhook endpoints to receive real-time notifications when transactions complete, fail, or change status.

# Webhook payload example
{
  "event": "deposit.completed",
  "webhook_id": "whk_abc123",
  "timestamp": 1701098200,
  "data": {
    "deposit_id": "dep_abc123xyz789",
    "reference_id": "DEP-001",
    "status": "completed",
    "amount": 100.00
  }
}

Developer Tools

Resources to help you build faster.

Complete API Documentation (PDF)

Comprehensive guide covering all APIs, authentication, webhooks, and best practices

Download PDF