Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.winampay.de/llms.txt

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

​
Standard error format

All error responses use a consistent JSON format: 
{
  "detail": "Explanatory error message"
}
For 422 (validation errors), detail is an array: 
{
  "detail": [
    {
      "type": "missing",
      "loc": ["body", "msisdn"],
      "msg": "Field required"
    }
  ]
}

​
HTTP error codes

CodeSituationExample detail
200Success (or idempotency hit)—
400Invalid parameter"Unknown operator: 'wave'. Accepted values: mtn, orange."
401Missing or invalid API key"Invalid or missing API key."
404Transaction not found"Transaction not found: 7c9e6679-..."
422Pydantic validation error (missing field, wrong type)Array of validation errors
503No provider available for this operator"No provider available for operator=mtn."
500Internal error"Internal error."

​
Common errors

Your X-API-Key header is missing or incorrect.
{ "detail": "Invalid or missing API key." }
Contact support@eins-innovativ.de to obtain or reset your API key.
The operator field must be "mtn" or "orange".
{ "detail": "Unknown operator: 'wave'. Accepted values: mtn, orange." }
Use POST /api/v1/msisdn/detect to automatically detect the operator from the MSISDN.
A required field is missing or has an invalid type.
{
  "detail": [
    { "type": "missing", "loc": ["body", "reference"], "msg": "Field required" }
  ]
}
All providers for the requested operator are currently unavailable (feature flag disabled or degraded).
{ "detail": "No provider available for operator=mtn." }
Check GET /api/v1/CM/providers/status for real-time provider health.