API Overview

Complete reference for all Pixlpay API endpoints.

Base URL

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

Authentication

All endpoints require Bearer token authentication:

Authorization: Bearer YOUR_API_TOKEN

Response Format

Success Response

{
  "success": true,
  "data": { ... }
}

Paginated Response

{
  "success": true,
  "data": [ ... ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 15,
    "total": 75
  }
}

Error Response

{
  "success": false,
  "error": "Not Found",
  "message": "Product not found"
}

Endpoints Overview

Products

Method	Endpoint	Description
GET	/products	List all products
GET	/products/{id}	Get single product

Orders

Method	Endpoint	Description
GET	/orders	List all orders
GET	/orders/{id}	Get single order
POST	/orders/{id}/fulfill	Mark order fulfilled

Customers

Method	Endpoint	Description
GET	/customers	List all customers
GET	/customers/{id}	Get single customer

Analytics

Method	Endpoint	Description
GET	/analytics/revenue	Revenue statistics
GET	/analytics/sales	Sales statistics

Gift Cards

Method	Endpoint	Description
GET	/gift-cards	List all gift cards
GET	/gift-cards/{id}	Get single gift card
POST	/gift-cards/validate	Check gift card balance
POST	/gift-cards/{id}/redeem	Redeem gift card
PUT	/gift-cards/{id}	Update gift card
POST	/gift-cards/{id}/revoke	Revoke gift card
GET	/gift-cards/statistics	Get gift card statistics
POST	/gift-cards/{id}/resend-email	Resend gift card email

Referrals

Method	Endpoint	Description
GET	/referrals	List all referrals
GET	/referrals/statistics	Get referral statistics
GET	/referrals/leaderboard	Get referral leaderboard
GET	/referrals/top-referrers	Get top referrers
POST	/referrals/validate	Validate referral code
GET	/referrals/tiers	List referral tiers
POST	/referrals/tiers	Create referral tier
PUT	/referrals/tiers/{id}	Update referral tier
DELETE	/referrals/tiers/{id}	Delete referral tier
POST	/referrals/tiers/{id}/toggle	Toggle tier status
GET	/referrals/settings	Get referral settings
PUT	/referrals/settings	Update referral settings
GET	/referrals/claims	List reward claims

Support Tickets

Method	Endpoint	Description
GET	/support-tickets	List all support tickets
GET	/support-tickets/{id}	Get single ticket with messages
GET	/support-tickets/stats	Get ticket statistics
PUT	/support-tickets/{id}/status	Update ticket status
POST	/support-tickets/{id}/messages	Add reply to ticket
POST	/support-tickets/{id}/close	Close a ticket
POST	/support-tickets/{id}/assign	Assign ticket to staff

Email Campaigns

Method	Endpoint	Description
GET	/email-campaigns	List all campaigns
GET	/email-campaigns/{id}	Get single campaign
POST	/email-campaigns	Create campaign
PUT	/email-campaigns/{id}	Update campaign
DELETE	/email-campaigns/{id}	Delete campaign
POST	/email-campaigns/{id}/send	Send or schedule campaign
GET	/email-campaigns/{id}/stats	Get campaign statistics
POST	/email-campaigns/{id}/duplicate	Duplicate campaign
GET	/email-campaigns/{id}/preview-recipients	Preview recipients

Fraud Detection

Method	Endpoint	Description
GET	/fraud/dashboard	Get fraud statistics
GET	/fraud/checks	List fraud checks
GET	/fraud/checks/{id}	Get single fraud check
POST	/fraud/checks/{id}/review	Review fraud check
GET	/fraud/settings	Get fraud settings
PUT	/fraud/settings	Update fraud settings
POST	/fraud/whitelist/ip	Add IP to whitelist
DELETE	/fraud/whitelist/ip	Remove IP from whitelist
POST	/fraud/whitelist/email	Add email to whitelist
DELETE	/fraud/whitelist/email	Remove email from whitelist
POST	/fraud/blocked-countries	Add country to block list
DELETE	/fraud/blocked-countries	Remove country from block list

Webhooks

Method	Endpoint	Description
GET	/webhooks	List webhooks
POST	/webhooks	Create webhook
DELETE	/webhooks/{id}	Delete webhook
POST	/webhooks/{id}/test	Test webhook

Pagination

Use page and per_page query parameters:

GET /products?page=2&per_page=25

• Default per_page: 15
• Maximum per_page: 100

Filtering

Most list endpoints support filtering:

GET /orders?status=completed&from=2025-01-01&to=2025-01-31

Sorting

Use sort and order parameters:

GET /products?sort=price&order=desc

Rate Limiting

• 60 requests per minute per token
• Headers indicate current status
• 429 response when exceeded