Quick Start

Make your first API call in 5 minutes.

Prerequisites

• An active Pixlpay store
• Basic knowledge of REST APIs
• cURL, Postman, or any HTTP client

Step 1: Create an API Token

1. Log into your Pixlpay dashboard
2. Go to Settings > API Tokens
3. Click Create Token
4. Enter a name (e.g., "My Integration")
5. Select scopes (or "Full Access" for testing)
6. Click Generate

Important

Copy your token immediately - it's only shown once!

Step 2: Make Your First Request

Let's fetch your products:

curl -X GET "https://yourstore.pixlpay.net/api/external/v1/products" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

Response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "VIP Rank",
      "price": "9.99",
      "type": "digital",
      "is_active": true
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 1
  }
}

Step 3: Fetch Orders

curl -X GET "https://yourstore.pixlpay.net/api/external/v1/orders?per_page=5" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

Response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "order_number": "ORD-2025-001",
      "status": "completed",
      "total": "29.99",
      "customer_email": "player@example.com",
      "created_at": "2025-01-20T14:30:00Z"
    }
  ]
}

Step 4: Set Up Webhooks

Receive real-time notifications:

curl -X POST "https://yourstore.pixlpay.net/api/external/v1/webhooks" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yourapp.com/webhooks",
    "events": ["order.created", "order.paid"]
  }'

Troubleshooting

401 Unauthorized

• Verify your token is correct
• Check token hasn't been revoked
• Ensure proper Authorization: Bearer format

Empty Response

• Your store may not have data yet
• Check filter parameters

Next Steps

• API Reference - All available endpoints
• Webhooks - Real-time notifications
• Code Examples - Ready-to-use code