Skip to main content

​
Overview

Use these endpoints to:
  • confirm the Commerce service is reachable (/status)
  • discover metadata like supported retailers and feature flags (/info)

​
Authentication

Requires x-commerce-api-key.

​
Request

Endpoints:
  • GET /api/commerce/status
  • GET /api/commerce/info
Example (status): 
BASE_URL=${PEPAY_API_URL}

curl "$BASE_URL/api/commerce/status" \
  -H "x-commerce-api-key: ck_..."

​
Response

Example (status): 
{
  "success": true,
  "data": {
    "status": "available",
    "escrowBalance": 50,
    "minimumRequired": 50,
    "features": {
      "search": true,
      "cart": true,
      "checkout": true,
      "orders": true
    }
  }
}

​
Errors

  • 401 missing/invalid commerce API key
  • 5xx service unavailable or transient failure

​
Examples

Example (info): 
BASE_URL=${PEPAY_API_URL}

curl "$BASE_URL/api/commerce/info" \
  -H "x-commerce-api-key: ck_..."
Next: Search