Commerce overview

​

Overview

• Base path: /api/commerce/*
• Merchant addresses: /api/v1/commerce/merchant/addresses
• SDK mapping: pepay.commerce.*
• Typical flow: Search → Merchant carts → Checkout invoice → Orders → Payments

​

Authentication

• x-commerce-api-key: ck_...

• Merchant operations (server-to-server): x-commerce-api-key
• Wallet-auth operations (not included here): x-commerce-api-key + User-Authorization: Bearer <userAccessToken>

​

Request

BASE_URL=${PEPAY_API_URL}

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

​

Response

{
  "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
• 429 rate limits (retry with backoff; respect Retry-After when present)
• 5xx transient errors (retry where safe)

​

Examples

1. Commerce APIs → 2) Search → 3) Checkout → 4) Orders