Skip to main content

iNPAY Developer API

The iNPAY Developer API enables merchants to integrate payment functionality directly into their applications. Build powerful payment solutions with our comprehensive set of endpoints for creating PayIDs, virtual accounts, and managing transactions.

🚀 Quick Start​

# Get your API credentials
curl -X POST https://api.inpaycheckout.com/api/v1/developer/payid/dynamic \
  -H "Authorization: Bearer sk_live_your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "order-123",
    "metadata": {
      "orderId": "ORDER-456",
      "customerEmail": "customer@example.com"
    }
  }'

🔑 Authentication​

All API requests require authentication using your secret key:

Authorization: Bearer sk_live_your_secret_key_here

Important: Keep your secret keys secure and never expose them in client-side code.

🌐 Base URLs​

  • Production: https://api.inpaycheckout.com
  • Development: https://sandbox-api.inpaycheckout.com

💰 Currency & Amounts​

All amounts are specified in kobo (1 Naira = 100 kobo):

  • ₦100.00 = 10000 kobo
  • ₦500.00 = 50000 kobo
  • ₦1000.00 = 100000 kobo

📚 API Versions​

We provide both REST and GraphQL APIs:

  • REST API: /api/v1/developer/
  • GraphQL API: /graphql

🎯 Core Features​

PayID Management​

  • Dynamic PayIDs: Auto-generated unique payment links
  • Static PayIDs: Custom branded payment links
  • PayID Verification: Validate PayID details before transfers

Virtual Accounts​

  • Dynamic Virtual Accounts: Temporary accounts for specific amounts
  • Amount Validation: Flexible validation rules (A0-A5)
  • Custom Expiration: Set validity periods up to 72 hours

Transfers​

  • PayID-to-PayID: Instant transfers between PayIDs
  • External Bank Transfers: Send to any Nigerian bank account
  • Account Verification: Verify bank accounts before transfers

Webhooks​

  • Real-time Notifications: Get instant payment updates
  • Secure Verification: HMAC signature validation
  • Event Types: Virtual account and PayID payment events

🔄 Rate Limits​

  • Requests per minute: 1000
  • Burst limit: 100 requests per second
  • Webhook retries: 3 attempts with exponential backoff

🛡️ Security​

  • HTTPS Required: All API requests must use HTTPS
  • Secret Key Authentication: Bearer token authentication
  • Webhook Signatures: HMAC-SHA256 signature verification
  • Environment Separation: Different keys for development and production

📖 What's Next?​