Developer Documentation

Build integrations with the Pixlpay API.

Overview

The Pixlpay API allows you to programmatically interact with your store:

• Fetch products and orders
• Process deliveries
• Access analytics data
• Manage webhooks
• Run a self-hosted Discord Agent for role delivery
• Build custom integrations

Getting Started

1. Quick Start - Make your first API call in 5 minutes
2. Authentication - Learn how to authenticate requests
3. API Reference - Complete endpoint documentation

Base URL

All API requests use your store's subdomain:

https://yourstore.pixlpay.net/api/external/v1/

Replace yourstore with your store's subdomain.

Authentication

All API requests require a Bearer token:

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

Create API tokens in your dashboard under Settings > API Tokens.

Response Format

All responses return JSON:

{
  "success": true,
  "data": { ... },
  "meta": {
    "current_page": 1,
    "total": 50
  }
}

Error Handling

Errors include a message and error code:

{
  "success": false,
  "error": "Unauthorized",
  "message": "Invalid or missing API token"
}

See Error Handling for all error codes.

Rate Limits

• 60 requests per minute per API token
• Rate limit headers included in all responses
• See Rate Limits for details

Need Help?

• Check our Code Examples for ready-to-use snippets
• Review Best Practices for integration tips
• Visit Support if you're stuck