Overview -old

Welcome to the Reveel PayID REST API reference. This section contains detailed documentation for every publicly accessible endpoint available to partner applications, wallets, and agents.

Reveel PayID APIs allow you to:

• Register users and PayIDs

• Define and manage custom routing rules

• Initiate cross-chain transactions

• Retrieve user and transaction history

---

🔐 Authentication

All API requests require a valid API key in the Authorization header.

httpCopyEditAuthorization: Bearer your-api-key
Content-Type: application/json
Accept: application/json

💡 API keys are issued after your application is approved. Request access here

---

🌍 Base URL

https://api.reveel.id/v1

---

🗂 API Categories

Endpoints are organized by functionality:

Category	Description
User APIs	Create and manage platform users
PayID APIs	Claim, check, and search PayIDs
Routes APIs	Configure how users want to receive payments
Transaction APIs	Trigger, track, and monitor payment flows
Agent APIs	Engage with a smart assistant to handle payments

---

📦 Response Format

All responses follow a standard structure:

jsonCopyEdit{
  "success": true,
  "message": "Action completed successfully",
  "data": {
    // endpoint-specific payload
  }
}

In case of error:

jsonCopyEdit{
  "success": false,
  "message": "Invalid PayID",
  "error": "PAYID_NOT_FOUND"
}

---

📋 Rate Limits & Versioning

• All endpoints are versioned under /v1

• Current rate limits: 100 requests/minute (subject to change)

• Abuse or misuse of APIs may result in throttling or key revocation

---

🧰 Tools

You can test the API using:

• cURL

• Postman Collection (coming soon)

• API playground (coming soon)