Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-alpha.pepay.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Use these endpoints to sanity-check commerce availability and inspect basic service metadata.

​
Authentication

Requires x-commerce-api-key for most commerce surfaces. 
const pepay = new Pepay({ commerceApiKey: process.env.PEPAY_COMMERCE_API_KEY! });

​
Request

​
Get commerce status

const status = await pepay.commerce.status();

​
Get commerce info

const info = await pepay.commerce.info();

​
Response

Example response: 
{
  "success": true,
  "data": {
    "status": "ok",
    "environment": "devnet"
  }
}

​
Errors

  • 401 missing/invalid commerce API key
  • 503 service unavailable (retry with backoff)

​
Examples

  • Treat these endpoints as diagnostics only; do not depend on them for business logic. Next: Commerce search