PayIDs - old
Parameter Reference
userId
string
Yes
Unique ID of the user registering or checking a PayID
payId
string
Yes
Desired PayID username (case-insensitive, alphanumeric)
expiresInYears
number
No
For premium PayIDs: the number of years to reserve
q
string
Yes (search)
Keyword to search PayIDs
limit
number
No
Max number of search results (default: 10)
activeOnly
boolean
No
Whether to return only active PayIDs (default: true)
Authentication
All endpoints require authentication unless explicitly stated otherwise.
Required Headers:
Authorization: Bearer your-api-key
Content-Type: application/json
Accept: application/json1. Register PayID
POST /payid/claim
Description: Registers a free or premium PayID for a user.
Request Body
Response – Premium PayID (Reserved)
Response – Free PayID (Claimed)
Error Responses
400 Bad Request
Missing or invalid fields
409 Conflict
PayID already claimed
500 Internal Server Error
General server or Loop API issue
2. Get PayID Price
GET /payid/check-price
Description: Returns the current price for a given PayID using AI scoring.
Query Parameters
userId(required)payId(required)
Success Response
Error Responses
400 Bad Request
Missing or malformed fields
409 Conflict
PayID already taken
500 Internal Server Error
Price check failure
3. Search PayIDs
GET /payid/search
Description: Searches Reveel's database for PayIDs by keyword.
Query Parameters
q(required): Search termlimit(optional): Max number of results (default: 10)activeOnly(optional): Only return active PayIDs (default: true)
Success Response
Error Responses
400 Bad Request
Invalid or missing q parameter
500 Internal Server Error
Search error
4. Premium PayID Purchase Webhook (Loop)
POST /payid/loop-webhook
Description: Receives webhook events from Loop on premium PayID purchases.
Request Body
Success Response
Error Responses
400 Bad Request
Invalid or missing fields
404 Not Found
Reservation ID not found
500 Internal Server Error
Failed to process webhook
Last updated
Was this helpful?

