Automating cryptocurrency payouts from web applications, mobile games, and custom faucets requires a reliable, hardened API gateway. ClaimX provides programmatic REST endpoints for real-time token dispatch.

1. Generating API Credentials

Developers can navigate to their Launchpad Wallets panel and generate a unique 64-character API token for any owned launchpad asset. This token must be stored securely in environment variables and never checked into public Git repositories.

2. Endpoint Specification & Request Schema

All programmatic payout requests must be transmitted via HTTPS POST to the ClaimX API Gateway:

POST /api/faucet/payout HTTP/1.1
Host: claimx.io
Content-Type: application/json
X-API-Key: YOUR_64_CHAR_TOKEN_SECRET

{
    "recipient_username": "satoshifun",
    "amount": "25.00000000",
    "coin_symbol": "CLAIMX",
    "nonce": "1727850000123"
}

3. Response Codes & Error Handling

The gateway returns standard HTTP status codes alongside deterministic JSON payloads:

  • 200 OK: Payout settled instantly. Response contains the internal transaction hash and remaining creator wallet balance.
  • 401 Unauthorized: Invalid API key or disabled wallet gateway.
  • 422 Unprocessable Entity: Insufficient wallet balance or invalid recipient identifier.
  • 429 Too Many Requests: Burst rate limit exceeded (maximum 60 requests/minute per API key).

4. PHP & Node.js Integration Snippet

// Example cURL request in PHP
$ch = curl_init('https://claimx.io/api/faucet/payout');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'recipient_username' => 'alice',
    'amount' => '10.50000000',
    'coin_symbol' => 'CLAIMX'
]));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'X-API-Key: ' . $apiKey
]);
$response = curl_exec($ch);
curl_close($ch);