Skip to main content
GET
/
api
/
commerce
/
status
Check commerce service status
curl --request GET \
  --url https://api-beta.pepay.io/api/commerce/status \
  --header 'x-commerce-api-key: <api-key>'
{
  "success": true,
  "data": {
    "status": "available",
    "escrowBalance": 50,
    "minimumRequired": 50,
    "features": {
      "search": true,
      "cart": true,
      "checkout": false,
      "orders": false
    }
  }
}

Authorizations

​
x-commerce-api-key
string
header
required

Legacy alias for commerce-scoped API keys. Prefer x-api-key with scope=commerce.

Response

Commerce is available

​
success
boolean
Example:

true

​
data
object