API Reference

Complete API reference for the OVN Pay platform.

Base URL

https://api.ovnpays.com/api/v1

Authentication

All API requests require authentication using an API key:

GET /api/v1/payouts
Authorization: Bearer your_api_key
Content-Type: application/json

Getting an API Key

Contact engineering@ovn.llc to request API access.

Rate Limits

• Default: 100 requests per minute
• Burst: Up to 200 requests in short bursts

Rate limit headers are included in all responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1635830400

Response Format

All responses follow this structure:

{
  "success": true,
  "data": { ... },
  "meta": {
    "requestId": "uuid",
    "timestamp": "2025-01-15T10:30:00Z"
  }
}

Errors

Errors are returned with appropriate HTTP status codes:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": { ... }
  }
}

Status Codes

Code	Description
200	Success
400	Bad Request / Validation Error
401	Unauthorized
403	Forbidden
404	Not Found
409	Conflict / Resource Already Exists
422	Unprocessable Entity
429	Rate Limit Exceeded
500	Internal Server Error
503	Service Unavailable