{ "openapi": "3.1.0", "info": { "title": "GMXAZ Bot Public API", "version": "v1", "description": "İmzalanmış sifariş webhook-ları daxil olmaqla GMXAZ Bot Public API üçün tam OpenAPI 3.1 tərifi." }, "servers": [ { "url": "https://gmx.az/api/v1" } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/getMe": { "get": { "tags": [ "Hesab" ], "operationId": "get_me", "summary": "API hesabını yoxla", "description": "API istifadəçisini, balansı və valyutanı qaytarır.\n\nAPI açarını və hesab vəziyyətini yoxlamaq üçün istifadə olunur.", "parameters": [], "responses": { "200": { "description": "API istifadəçisini, balansı və valyutanı qaytarır.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "user_id": { "type": "integer", "example": 579365494 }, "username": { "type": "string", "example": "reseller_pro" }, "balance": { "type": "string", "example": "1250.5000" }, "currency": { "type": "string", "example": "USD" }, "webhook_secret_configured": { "type": "boolean", "example": true } }, "example": { "user_id": 579365494, "username": "reseller_pro", "balance": "1250.5000", "currency": "USD", "webhook_secret_configured": true }, "additionalProperties": true } }, "example": { "success": true, "data": { "user_id": 579365494, "username": "reseller_pro", "balance": "1250.5000", "currency": "USD", "webhook_secret_configured": true } }, "additionalProperties": true }, "example": { "success": true, "data": { "user_id": 579365494, "username": "reseller_pro", "balance": "1250.5000", "currency": "USD", "webhook_secret_configured": true } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } } } } }, "/games": { "get": { "tags": [ "Kataloq" ], "operationId": "games", "summary": "Oyunları siyahıla", "description": "Aktiv oyunları və kateqoriyaları qaytarır.\n\nOyunları tipə və ada görə süzmək mümkündür.", "parameters": [ { "name": "type", "in": "query", "required": false, "description": "Məhsul növü filtri.", "schema": { "type": "string", "enum": [ "voucher", "topup" ], "example": "topup" } }, { "name": "q", "in": "query", "required": false, "description": "Oyun adına görə axtarış.", "schema": { "type": "string", "example": "pubg" } } ], "responses": { "200": { "description": "Aktiv oyunları və kateqoriyaları qaytarır.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "PUBG Mobile" }, "type": { "type": "string", "example": "TOPUP" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 10 }, "name": { "type": "string", "example": "Global" }, "per_page_count": { "type": "integer", "example": 12 } }, "example": { "id": 10, "name": "Global", "per_page_count": 12 }, "additionalProperties": true }, "example": [ { "id": 10, "name": "Global", "per_page_count": 12 } ] } }, "example": { "id": 1, "name": "PUBG Mobile", "type": "TOPUP", "categories": [ { "id": 10, "name": "Global", "per_page_count": 12 } ] }, "additionalProperties": true }, "example": [ { "id": 1, "name": "PUBG Mobile", "type": "TOPUP", "categories": [ { "id": 10, "name": "Global", "per_page_count": 12 } ] } ] } }, "example": { "success": true, "data": [ { "id": 1, "name": "PUBG Mobile", "type": "TOPUP", "categories": [ { "id": 10, "name": "Global", "per_page_count": 12 } ] } ] }, "additionalProperties": true }, "example": { "success": true, "data": [ { "id": 1, "name": "PUBG Mobile", "type": "TOPUP", "categories": [ { "id": 10, "name": "Global", "per_page_count": 12 } ] } ] } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "422": { "description": "type və ya q parametrinin formatı yanlışdır.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "VALIDATION_ERROR": { "value": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "type və ya q parametrinin formatı yanlışdır." } } } } } } } } } }, "/categories": { "get": { "tags": [ "Kataloq" ], "operationId": "categories", "summary": "Kateqoriyaları siyahıla", "description": "Seçilmiş oyuna aid aktiv kateqoriyaları qaytarır.\n\ngame_id /games cavabındakı oyun ID-sidir.", "parameters": [ { "name": "game_id", "in": "query", "required": true, "description": "Aktiv oyun ID-si.", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Seçilmiş oyuna aid aktiv kateqoriyaları qaytarır.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 10 }, "name": { "type": "string", "example": "Global" }, "per_page_count": { "type": "integer", "example": 12 } }, "example": { "id": 10, "name": "Global", "per_page_count": 12 }, "additionalProperties": true }, "example": [ { "id": 10, "name": "Global", "per_page_count": 12 } ] } }, "example": { "success": true, "data": [ { "id": 10, "name": "Global", "per_page_count": 12 } ] }, "additionalProperties": true }, "example": { "success": true, "data": [ { "id": 10, "name": "Global", "per_page_count": 12 } ] } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "422": { "description": "game_id göndərilməyib və ya tam ədəd deyil.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "VALIDATION_ERROR": { "value": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "game_id göndərilməyib və ya tam ədəd deyil." } } } } } } }, "404": { "description": "Oyun tapılmadı və ya aktiv deyil.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "GAME_NOT_FOUND": { "value": { "success": false, "error": { "code": "GAME_NOT_FOUND", "message": "Oyun tapılmadı və ya aktiv deyil." } } } } } } } } } }, "/products": { "get": { "tags": [ "Kataloq" ], "operationId": "products", "summary": "Məhsulları siyahıla", "description": "Aktiv məhsulları qiymət, stok və səhifələmə ilə qaytarır.\n\nFiltrlər birlikdə istifadə edilə bilər.", "parameters": [ { "name": "type", "in": "query", "required": false, "description": "vauçer və ya Top-up.", "schema": { "type": "string", "enum": [ "voucher", "topup" ], "example": "topup" } }, { "name": "game", "in": "query", "required": false, "description": "Oyun adına görə qismən axtarış.", "schema": { "type": "string", "example": "PUBG" } }, { "name": "category", "in": "query", "required": false, "description": "Kateqoriya adına görə qismən axtarış.", "schema": { "type": "string", "example": "Global" } }, { "name": "game_id", "in": "query", "required": false, "description": "Oyun ID-si.", "schema": { "type": "integer", "example": 1 } }, { "name": "category_id", "in": "query", "required": false, "description": "Kateqoriya ID-si.", "schema": { "type": "integer", "example": 10 } }, { "name": "q", "in": "query", "required": false, "description": "Məhsul adına görə axtarış.", "schema": { "type": "string", "example": "60 UC" } }, { "name": "page", "in": "query", "required": false, "description": "Səhifə nömrəsi.", "schema": { "type": "integer", "example": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Səhifə ölçüsü. Maksimum: 100.", "schema": { "type": "integer", "example": 50 } } ], "responses": { "200": { "description": "Aktiv məhsulları qiymət, stok və səhifələmə ilə qaytarır.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 91 }, "name": { "type": "string", "example": "PUBG Mobile 60 UC" }, "game_id": { "type": "integer", "example": 1 }, "game": { "type": "string", "example": "PUBG Mobile" }, "category_id": { "type": "integer", "example": 10 }, "category": { "type": "string", "example": "Global" }, "type": { "type": "string", "example": "TOPUP" }, "fulfillment_type": { "type": "string", "example": "standard" }, "is_qr_login": { "type": "boolean", "example": false }, "price": { "type": "string", "example": "0.8800" }, "currency": { "type": "string", "example": "USD" }, "stock_status": { "type": "string", "example": "INFINITE" }, "stock_count": { "type": [ "string", "null" ] }, "min_qty": { "type": "integer", "example": 1 }, "max_qty": { "type": "integer", "example": 1 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "player_id" }, "label": { "type": "string", "example": "Oyunçu ID-si" }, "required": { "type": "boolean", "example": true } }, "example": { "key": "player_id", "label": "Oyunçu ID-si", "required": true }, "additionalProperties": true }, "example": [ { "key": "player_id", "label": "Oyunçu ID-si", "required": true } ] }, "supports_player_validation": { "type": "boolean", "example": true } }, "example": { "id": 91, "name": "PUBG Mobile 60 UC", "game_id": 1, "game": "PUBG Mobile", "category_id": 10, "category": "Global", "type": "TOPUP", "fulfillment_type": "standard", "is_qr_login": false, "price": "0.8800", "currency": "USD", "stock_status": "INFINITE", "stock_count": null, "min_qty": 1, "max_qty": 1, "fields": [ { "key": "player_id", "label": "Oyunçu ID-si", "required": true } ], "supports_player_validation": true }, "additionalProperties": true }, "example": [ { "id": 91, "name": "PUBG Mobile 60 UC", "game_id": 1, "game": "PUBG Mobile", "category_id": 10, "category": "Global", "type": "TOPUP", "fulfillment_type": "standard", "is_qr_login": false, "price": "0.8800", "currency": "USD", "stock_status": "INFINITE", "stock_count": null, "min_qty": 1, "max_qty": 1, "fields": [ { "key": "player_id", "label": "Oyunçu ID-si", "required": true } ], "supports_player_validation": true } ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "per_page": { "type": "integer", "example": 50 }, "total": { "type": "integer", "example": 1 } }, "example": { "current_page": 1, "last_page": 1, "per_page": 50, "total": 1 }, "additionalProperties": true } }, "example": { "success": true, "data": [ { "id": 91, "name": "PUBG Mobile 60 UC", "game_id": 1, "game": "PUBG Mobile", "category_id": 10, "category": "Global", "type": "TOPUP", "fulfillment_type": "standard", "is_qr_login": false, "price": "0.8800", "currency": "USD", "stock_status": "INFINITE", "stock_count": null, "min_qty": 1, "max_qty": 1, "fields": [ { "key": "player_id", "label": "Oyunçu ID-si", "required": true } ], "supports_player_validation": true } ], "meta": { "current_page": 1, "last_page": 1, "per_page": 50, "total": 1 } }, "additionalProperties": true }, "example": { "success": true, "data": [ { "id": 91, "name": "PUBG Mobile 60 UC", "game_id": 1, "game": "PUBG Mobile", "category_id": 10, "category": "Global", "type": "TOPUP", "fulfillment_type": "standard", "is_qr_login": false, "price": "0.8800", "currency": "USD", "stock_status": "INFINITE", "stock_count": null, "min_qty": 1, "max_qty": 1, "fields": [ { "key": "player_id", "label": "Oyunçu ID-si", "required": true } ], "supports_player_validation": true } ], "meta": { "current_page": 1, "last_page": 1, "per_page": 50, "total": 1 } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "422": { "description": "Filtr və ya səhifələmə parametri yanlışdır.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "VALIDATION_ERROR": { "value": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Filtr və ya səhifələmə parametri yanlışdır." } } } } } } } } } }, "/validate-player": { "post": { "tags": [ "Yoxlama" ], "operationId": "validate_player", "summary": "Oyunçu məlumatını yoxla", "description": "Oyunçu və server məlumatlarını yoxlayır.\n\nMəhsul üçün oyunçu yoxlamasının nəticəsini qaytarır.", "parameters": [], "responses": { "200": { "description": "Oyunçu və server məlumatlarını yoxlayır.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "nickname": { "type": "string", "example": "PlayerOne" }, "player_name": { "type": "string", "example": "PlayerOne" }, "region": { "type": "string", "example": "TR" }, "country": { "type": "string", "example": "TR" }, "server": { "type": "string", "example": "1234" }, "nickname_verified": { "type": "boolean", "example": true }, "validation_optional": { "type": "boolean", "example": false } }, "example": { "nickname": "PlayerOne", "player_name": "PlayerOne", "region": "TR", "country": "TR", "server": "1234", "nickname_verified": true, "validation_optional": false }, "additionalProperties": true } }, "example": { "success": true, "data": { "nickname": "PlayerOne", "player_name": "PlayerOne", "region": "TR", "country": "TR", "server": "1234", "nickname_verified": true, "validation_optional": false } }, "additionalProperties": true }, "example": { "success": true, "data": { "nickname": "PlayerOne", "player_name": "PlayerOne", "region": "TR", "country": "TR", "server": "1234", "nickname_verified": true, "validation_optional": false } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "422": { "description": "Sorğu gövdəsi yanlışdır.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "VALIDATION_ERROR": { "value": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Sorğu gövdəsi yanlışdır." } } } } } } }, "404": { "description": "Top-up məhsulu tapılmadı.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "PRODUCT_NOT_FOUND": { "value": { "success": false, "error": { "code": "PRODUCT_NOT_FOUND", "message": "Top-up məhsulu tapılmadı." } } }, "PLAYER_NOT_FOUND": { "value": { "success": false, "error": { "code": "PLAYER_NOT_FOUND", "message": "Oyunçu yoxlanmadı." } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "product_id": { "type": "integer", "example": 91, "description": "Top-up məhsulunun ID-si." }, "player_id": { "type": "string", "example": "51515969536", "description": "Oyunçu ID-si." }, "server_id": { "type": "string", "example": "1234", "description": "Server və ya zona ID-si." }, "input_2": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_3": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_4": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_5": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_6": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_7": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_8": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." } }, "additionalProperties": false, "required": [ "product_id", "player_id" ] }, "example": { "product_id": 91, "player_id": "51515969536", "server_id": "1234", "input_3": "CharacterName" } } } } } }, "/order": { "post": { "tags": [ "Sifarişlər" ], "operationId": "place_order", "summary": "Sifariş yarat", "description": "vauçer və ya Top-up sifarişi yaradır.\n\nBu sorğu faktiki maliyyə əməliyyatı yaradır. Təkrar sorğular üçün X-Idempotency-Key istifadə edin.", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "required": false, "description": "Unikal təkrar cəhd açarı. Balansı dəyişən əməliyyatlarda tələb olunur; POST /order üçün client_order_id ehtiyat açar kimi istifadə edilə bilər.", "schema": { "type": "string", "example": "550e8400-e29b-41d4-a716-446655440000" } } ], "responses": { "200": { "description": "vauçer və ya Top-up sifarişi yaradır.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "order_id": { "type": "integer", "example": 8821 }, "order_uuid": { "type": "string", "example": "a80f63d7-cabb-4e1d-a177-045f6467e7b2" }, "client_order_id": { "type": "string", "example": "order-10001" }, "product_id": { "type": "integer", "example": 91 }, "product_name": { "type": "string", "example": "PUBG Mobile 60 UC" }, "product_type": { "type": "string", "example": "TOPUP" }, "qty": { "type": "integer", "example": 1 }, "player_id": { "type": "string", "example": "51515969536" }, "server_id": { "type": "string", "example": "1234" }, "player_name": { "type": "string", "example": "PlayerOne" }, "region": { "type": "string", "example": "TR" }, "status": { "type": "string", "example": "PROCESSING" }, "price": { "type": "string", "example": "0.8800" }, "currency": { "type": "string", "example": "USD" }, "delivery": { "type": [ "string", "null" ] }, "manual_action_required": { "type": "boolean", "example": false }, "delivery_message": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "example": "2026-07-25T13:30:00+04:00" }, "completed_at": { "type": [ "string", "null" ] } }, "example": { "order_id": 8821, "order_uuid": "a80f63d7-cabb-4e1d-a177-045f6467e7b2", "client_order_id": "order-10001", "product_id": 91, "product_name": "PUBG Mobile 60 UC", "product_type": "TOPUP", "qty": 1, "player_id": "51515969536", "server_id": "1234", "player_name": "PlayerOne", "region": "TR", "status": "PROCESSING", "price": "0.8800", "currency": "USD", "delivery": null, "manual_action_required": false, "delivery_message": null, "created_at": "2026-07-25T13:30:00+04:00", "completed_at": null }, "additionalProperties": true } }, "example": { "success": true, "data": { "order_id": 8821, "order_uuid": "a80f63d7-cabb-4e1d-a177-045f6467e7b2", "client_order_id": "order-10001", "product_id": 91, "product_name": "PUBG Mobile 60 UC", "product_type": "TOPUP", "qty": 1, "player_id": "51515969536", "server_id": "1234", "player_name": "PlayerOne", "region": "TR", "status": "PROCESSING", "price": "0.8800", "currency": "USD", "delivery": null, "manual_action_required": false, "delivery_message": null, "created_at": "2026-07-25T13:30:00+04:00", "completed_at": null } }, "additionalProperties": true }, "example": { "success": true, "data": { "order_id": 8821, "order_uuid": "a80f63d7-cabb-4e1d-a177-045f6467e7b2", "client_order_id": "order-10001", "product_id": 91, "product_name": "PUBG Mobile 60 UC", "product_type": "TOPUP", "qty": 1, "player_id": "51515969536", "server_id": "1234", "player_name": "PlayerOne", "region": "TR", "status": "PROCESSING", "price": "0.8800", "currency": "USD", "delivery": null, "manual_action_required": false, "delivery_message": null, "created_at": "2026-07-25T13:30:00+04:00", "completed_at": null } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "422": { "description": "Sorğu gövdəsi sahələrindən biri yanlışdır.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "VALIDATION_ERROR": { "value": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Sorğu gövdəsi sahələrindən biri yanlışdır." } } }, "INVALID_QUANTITY": { "value": { "success": false, "error": { "code": "INVALID_QUANTITY", "message": "Say icazə verilən limiti keçir." } } }, "PLAYER_ID_REQUIRED": { "value": { "success": false, "error": { "code": "PLAYER_ID_REQUIRED", "message": "player_id sahəsi məcburidir." } } }, "SERVER_ID_REQUIRED": { "value": { "success": false, "error": { "code": "SERVER_ID_REQUIRED", "message": "server_id sahəsi məcburidir." } } }, "IDEMPOTENCY_KEY_REQUIRED": { "value": { "success": false, "error": { "code": "IDEMPOTENCY_KEY_REQUIRED", "message": "Bu əməliyyat üçün stabil idempotency açarı tələb olunur." } } }, "IDEMPOTENCY_KEY_INVALID": { "value": { "success": false, "error": { "code": "IDEMPOTENCY_KEY_INVALID", "message": "Idempotency açarı yanlışdır və ya 128 simvoldan uzundur." } } } } } } }, "404": { "description": "Məhsul tapılmadı.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "PRODUCT_NOT_FOUND": { "value": { "success": false, "error": { "code": "PRODUCT_NOT_FOUND", "message": "Məhsul tapılmadı." } } }, "PLAYER_NOT_FOUND": { "value": { "success": false, "error": { "code": "PLAYER_NOT_FOUND", "message": "Oyunçu yoxlaması uğursuzdur." } } } } } } }, "400": { "description": "Balans kifayət etmir.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "INSUFFICIENT_FUNDS": { "value": { "success": false, "error": { "code": "INSUFFICIENT_FUNDS", "message": "Balans kifayət etmir." } } }, "SECURITY_ERROR": { "value": { "success": false, "error": { "code": "SECURITY_ERROR", "message": "Geri çağırış URL-si təhlükəsizlik qaydalarına uyğun deyil." } } } } } } }, "409": { "description": "Sifariş emal edilə bilmədi.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "OUT_OF_STOCK": { "value": { "success": false, "error": { "code": "OUT_OF_STOCK", "message": "Sifariş emal edilə bilmədi." } } }, "IDEMPOTENCY_CONFLICT": { "value": { "success": false, "error": { "code": "IDEMPOTENCY_CONFLICT", "message": "Eyni açar fərqli sorğu ilə istifadə edilib." } } }, "CLIENT_ORDER_ID_CONFLICT": { "value": { "success": false, "error": { "code": "CLIENT_ORDER_ID_CONFLICT", "message": "Eyni client_order_id artıq başqa sifarişə təyin edilib." } } }, "ORDER_FAILED": { "value": { "success": false, "error": { "code": "ORDER_FAILED", "message": "Sifariş emal edilə bilmədi." } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "product_id": { "type": "integer", "example": 91, "description": "Aktiv məhsul ID-si." }, "qty": { "type": "integer", "example": 1, "description": "Vauçer üçün maksimum: 500; top-up üçün maksimum: 1." }, "player_id": { "type": "string", "example": "51515969536", "description": "Top-up məhsulu üçün məcburidir." }, "server_id": { "type": "string", "example": "1234", "description": "Server və ya zona ID-si." }, "input_2": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_3": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_4": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_5": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_6": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_7": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "input_8": { "type": "string", "example": "Additional mapped values", "description": "Məhsulun sahələr siyahısına uyğun əlavə input_2...input_8 dəyərləri." }, "client_order_id": { "type": "string", "example": "client-order-10001", "description": "Sizin sifariş referansınız. POST /order sorğusunda X-Idempotency-Key göndərilməzsə, bu dəyər təkrar cəhd açarı kimi də istifadə olunur." }, "callback_url": { "type": "string", "example": "https://customer.example/webhooks/bot-manager", "description": "Təhlükəsiz HTTPS geri çağırış URL-si." }, "callback_mode": { "type": "string", "enum": [ "legacy", "events" ], "example": "legacy", "description": "Geri çağırış formatı. Standart: legacy." } }, "additionalProperties": false, "required": [ "product_id" ] }, "example": { "product_id": 91, "qty": 1, "player_id": "51515969536", "server_id": "1234", "input_3": "CharacterName", "client_order_id": "client-order-10001", "callback_url": "https://customer.example/webhooks/bot-manager", "callback_mode": "events" } } } } } }, "/order/{id}/qr-login/status": { "get": { "tags": [ "Sifarişlər" ], "operationId": "qr_login_status", "summary": "QR Login statusu", "description": "Sizə aid sifarişin canlı QR Login icra statusunu alın.\n\nQR mövcudluğunu, versiyanı, əməkdaş statusunu, bitmə vaxtını və hazırda mümkün əməliyyatları qaytarır.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Sifariş ID-si, order_uuid və ya client_order_id.", "schema": { "type": "string", "example": "8821" } } ], "responses": { "200": { "description": "Sizə aid sifarişin canlı QR Login icra statusunu alın.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "order_id": { "type": "integer", "example": 8821 }, "order_status": { "type": "string", "example": "PROCESSING" }, "session_status": { "type": "string", "example": "QR_READY" }, "status_label": { "type": "string", "example": "QR code is ready." }, "has_qr": { "type": "boolean", "example": true }, "qr_version": { "type": "integer", "example": 1 }, "qr_image_url": { "type": "string", "example": "https://gmx.az/api/v1/order/8821/qr-login/preview?v=1" }, "expires_at": { "type": "string", "example": "2026-08-17T16:30:00+04:00" }, "can_mark_scanned": { "type": "boolean", "example": true }, "can_request_new_qr": { "type": "boolean", "example": true }, "can_submit_otp": { "type": "boolean", "example": false }, "is_final": { "type": "boolean", "example": false } }, "example": { "order_id": 8821, "order_status": "PROCESSING", "session_status": "QR_READY", "status_label": "QR code is ready.", "has_qr": true, "qr_version": 1, "qr_image_url": "https://gmx.az/api/v1/order/8821/qr-login/preview?v=1", "expires_at": "2026-08-17T16:30:00+04:00", "can_mark_scanned": true, "can_request_new_qr": true, "can_submit_otp": false, "is_final": false }, "additionalProperties": true } }, "example": { "success": true, "data": { "order_id": 8821, "order_status": "PROCESSING", "session_status": "QR_READY", "status_label": "QR code is ready.", "has_qr": true, "qr_version": 1, "qr_image_url": "https://gmx.az/api/v1/order/8821/qr-login/preview?v=1", "expires_at": "2026-08-17T16:30:00+04:00", "can_mark_scanned": true, "can_request_new_qr": true, "can_submit_otp": false, "is_final": false } }, "additionalProperties": true }, "example": { "success": true, "data": { "order_id": 8821, "order_status": "PROCESSING", "session_status": "QR_READY", "status_label": "QR code is ready.", "has_qr": true, "qr_version": 1, "qr_image_url": "https://gmx.az/api/v1/order/8821/qr-login/preview?v=1", "expires_at": "2026-08-17T16:30:00+04:00", "can_mark_scanned": true, "can_request_new_qr": true, "can_submit_otp": false, "is_final": false } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "404": { "description": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ORDER_NOT_FOUND": { "value": { "success": false, "error": { "code": "ORDER_NOT_FOUND", "message": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil." } } } } } } } } } }, "/order/{id}/qr-login/preview": { "get": { "tags": [ "Sifarişlər" ], "operationId": "qr_login_preview", "summary": "QR Login görüntüsü", "description": "Hazırda aktiv olan QR şəklini alın.\n\nQR aktiv olduğu müddətdə özəl JPEG faylı qaytarılır. Sorğunu eyni API açarı ilə autentifikasiya edin. Brauzerdə adi teqi X-API-KEY başlığı göndərə bilmədiyi üçün şəkli autentifikasiyalı binary/blob sorğusu ilə alın və qaytarılan obyekt URL-sini göstərin.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Sifariş ID-si, order_uuid və ya client_order_id.", "schema": { "type": "string", "example": "8821" } }, { "name": "v", "in": "query", "required": false, "description": "Opsional QR versiya cache-buster dəyəri.", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Hazırda aktiv olan QR şəklini alın.", "content": { "application/json": { "schema": { "type": "string", "example": "Binary image/jpeg cavabı." }, "example": "Binary image/jpeg cavabı." } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "404": { "description": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ORDER_NOT_FOUND": { "value": { "success": false, "error": { "code": "ORDER_NOT_FOUND", "message": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil." } } } } } } } } } }, "/order/{id}/qr-login/scanned": { "post": { "tags": [ "Sifarişlər" ], "operationId": "qr_login_scanned", "summary": "QR skanını təsdiqlə", "description": "Müştərinin aktiv QR-ni skan etdiyini təyin edilmiş əməkdaşyə bildirin.\n\nYalnız müştəri QR-ni həqiqətən skan etdikdən sonra istifadə edin. Bu əməliyyat sifarişi özü tamamlamır.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Sifariş ID-si, order_uuid və ya client_order_id.", "schema": { "type": "string", "example": "8821" } } ], "responses": { "200": { "description": "Müştərinin aktiv QR-ni skan etdiyini təyin edilmiş əməkdaşyə bildirin.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "session_status": { "type": "string", "example": "customer_scanned" }, "has_qr": { "type": "boolean", "example": true } }, "example": { "session_status": "customer_scanned", "has_qr": true }, "additionalProperties": true } }, "example": { "success": true, "data": { "session_status": "customer_scanned", "has_qr": true } }, "additionalProperties": true }, "example": { "success": true, "data": { "session_status": "customer_scanned", "has_qr": true } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "404": { "description": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ORDER_NOT_FOUND": { "value": { "success": false, "error": { "code": "ORDER_NOT_FOUND", "message": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil." } } } } } } } } } }, "/order/{id}/qr-login/new-qr": { "post": { "tags": [ "Sifarişlər" ], "operationId": "qr_login_new_qr", "summary": "Yeni QR tələb et", "description": "Hazırkı QR-ni etibarsız edib əvəzini tələb edin.\n\nGöstərilən QR-nin vaxtı bitdikdə və ya skan olunmadıqda istifadə edin.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Sifariş ID-si, order_uuid və ya client_order_id.", "schema": { "type": "string", "example": "8821" } } ], "responses": { "200": { "description": "Hazırkı QR-ni etibarsız edib əvəzini tələb edin.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "session_status": { "type": "string", "example": "awaiting_new_qr" }, "has_qr": { "type": "boolean", "example": false } }, "example": { "session_status": "awaiting_new_qr", "has_qr": false }, "additionalProperties": true } }, "example": { "success": true, "data": { "session_status": "awaiting_new_qr", "has_qr": false } }, "additionalProperties": true }, "example": { "success": true, "data": { "session_status": "awaiting_new_qr", "has_qr": false } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "404": { "description": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ORDER_NOT_FOUND": { "value": { "success": false, "error": { "code": "ORDER_NOT_FOUND", "message": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil." } } } } } } } } } }, "/order/{id}/qr-login/otp": { "post": { "tags": [ "Sifarişlər" ], "operationId": "qr_login_otp", "summary": "QR Login OTP göndər", "description": "Təyin edilmiş əməkdaşnin tələb etdiyi birdəfəlik kodu göndərin.\n\nOTP yalnız awaiting_otp mərhələsində qəbul edilir, DB-də saxlanmadan təyin edilmiş əməkdaşyə ötürülür.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Sifariş ID-si, order_uuid və ya client_order_id.", "schema": { "type": "string", "example": "8821" } } ], "responses": { "200": { "description": "Təyin edilmiş əməkdaşnin tələb etdiyi birdəfəlik kodu göndərin.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "session_status": { "type": "string", "example": "customer_scanned" }, "has_qr": { "type": "boolean", "example": true } }, "example": { "session_status": "customer_scanned", "has_qr": true }, "additionalProperties": true } }, "example": { "success": true, "data": { "session_status": "customer_scanned", "has_qr": true } }, "additionalProperties": true }, "example": { "success": true, "data": { "session_status": "customer_scanned", "has_qr": true } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "422": { "description": "OTP 4-10 rəqəmdən ibarət olmalıdır.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "VALIDATION_ERROR": { "value": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "OTP 4-10 rəqəmdən ibarət olmalıdır." } } } } } } }, "404": { "description": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ORDER_NOT_FOUND": { "value": { "success": false, "error": { "code": "ORDER_NOT_FOUND", "message": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil." } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "otp": { "type": "string", "example": "123456", "description": "4-10 rəqəmli birdəfəlik kod." } }, "additionalProperties": false, "required": [ "otp" ] }, "example": { "otp": "123456" } } } } } }, "/order/{id}": { "get": { "tags": [ "Sifarişlər" ], "operationId": "order_status", "summary": "Sifariş statusunu al", "description": "Sifarişi ID, UUID və ya client_order_id ilə tapır.\n\nSifarişin cari statusunu və mümkün təqdimat məlumatını qaytarır.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Sifariş ID-si, order_uuid və ya client_order_id.", "schema": { "type": "string", "example": "8821" } } ], "responses": { "200": { "description": "Sifarişi ID, UUID və ya client_order_id ilə tapır.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "order_id": { "type": "integer", "example": 8821 }, "order_uuid": { "type": "string", "example": "a80f63d7-cabb-4e1d-a177-045f6467e7b2" }, "client_order_id": { "type": "string", "example": "order-10001" }, "product_id": { "type": "integer", "example": 17 }, "product_name": { "type": "string", "example": "Steam Wallet 10 USD" }, "product_type": { "type": "string", "example": "VOUCHER" }, "qty": { "type": "integer", "example": 2 }, "player_id": { "type": [ "string", "null" ] }, "server_id": { "type": [ "string", "null" ] }, "player_name": { "type": [ "string", "null" ] }, "region": { "type": [ "string", "null" ] }, "status": { "type": "string", "example": "COMPLETED" }, "price": { "type": "string", "example": "19.9800" }, "currency": { "type": "string", "example": "USD" }, "delivery": { "type": "array", "items": { "type": "string", "example": "CODE-ONE-XXXX" }, "example": [ "CODE-ONE-XXXX", "CODE-TWO-XXXX" ] }, "manual_action_required": { "type": "boolean", "example": false }, "delivery_message": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "example": "2026-07-25T13:30:00+04:00" }, "completed_at": { "type": "string", "example": "2026-07-25T13:31:10+04:00" } }, "example": { "order_id": 8821, "order_uuid": "a80f63d7-cabb-4e1d-a177-045f6467e7b2", "client_order_id": "order-10001", "product_id": 17, "product_name": "Steam Wallet 10 USD", "product_type": "VOUCHER", "qty": 2, "player_id": null, "server_id": null, "player_name": null, "region": null, "status": "COMPLETED", "price": "19.9800", "currency": "USD", "delivery": [ "CODE-ONE-XXXX", "CODE-TWO-XXXX" ], "manual_action_required": false, "delivery_message": null, "created_at": "2026-07-25T13:30:00+04:00", "completed_at": "2026-07-25T13:31:10+04:00" }, "additionalProperties": true } }, "example": { "success": true, "data": { "order_id": 8821, "order_uuid": "a80f63d7-cabb-4e1d-a177-045f6467e7b2", "client_order_id": "order-10001", "product_id": 17, "product_name": "Steam Wallet 10 USD", "product_type": "VOUCHER", "qty": 2, "player_id": null, "server_id": null, "player_name": null, "region": null, "status": "COMPLETED", "price": "19.9800", "currency": "USD", "delivery": [ "CODE-ONE-XXXX", "CODE-TWO-XXXX" ], "manual_action_required": false, "delivery_message": null, "created_at": "2026-07-25T13:30:00+04:00", "completed_at": "2026-07-25T13:31:10+04:00" } }, "additionalProperties": true }, "example": { "success": true, "data": { "order_id": 8821, "order_uuid": "a80f63d7-cabb-4e1d-a177-045f6467e7b2", "client_order_id": "order-10001", "product_id": 17, "product_name": "Steam Wallet 10 USD", "product_type": "VOUCHER", "qty": 2, "player_id": null, "server_id": null, "player_name": null, "region": null, "status": "COMPLETED", "price": "19.9800", "currency": "USD", "delivery": [ "CODE-ONE-XXXX", "CODE-TWO-XXXX" ], "manual_action_required": false, "delivery_message": null, "created_at": "2026-07-25T13:30:00+04:00", "completed_at": "2026-07-25T13:31:10+04:00" } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "404": { "description": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ORDER_NOT_FOUND": { "value": { "success": false, "error": { "code": "ORDER_NOT_FOUND", "message": "Sifariş tapılmadı və ya bu istifadəçiyə aid deyil." } } } } } } } } } }, "/order-status/{id}": { "get": { "tags": [ "Sifarişlər" ], "operationId": "order_status_legacy", "summary": "Köhnə status ünvanı", "description": "/order/{id} ünvanının uyğunluq variantıdır.\n\nYeni inteqrasiyalarda /order/{id} istifadə edin.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Sifariş ID-si, order_uuid və ya client_order_id.", "schema": { "type": "string", "example": "8821" } } ], "responses": { "200": { "description": "/order/{id} ünvanının uyğunluq variantıdır.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "order_id": { "type": "integer", "example": 8821 }, "status": { "type": "string", "example": "COMPLETED" }, "delivery": { "type": "array", "items": { "type": "string", "example": "CODE-ONE-XXXX" }, "example": [ "CODE-ONE-XXXX" ] }, "manual_action_required": { "type": "boolean", "example": false }, "delivery_message": { "type": [ "string", "null" ] } }, "example": { "order_id": 8821, "status": "COMPLETED", "delivery": [ "CODE-ONE-XXXX" ], "manual_action_required": false, "delivery_message": null }, "additionalProperties": true } }, "example": { "success": true, "data": { "order_id": 8821, "status": "COMPLETED", "delivery": [ "CODE-ONE-XXXX" ], "manual_action_required": false, "delivery_message": null } }, "additionalProperties": true }, "example": { "success": true, "data": { "order_id": 8821, "status": "COMPLETED", "delivery": [ "CODE-ONE-XXXX" ], "manual_action_required": false, "delivery_message": null } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "404": { "description": "Sifariş tapılmadı.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ORDER_NOT_FOUND": { "value": { "success": false, "error": { "code": "ORDER_NOT_FOUND", "message": "Sifariş tapılmadı." } } } } } } } } } }, "/orders": { "get": { "tags": [ "Sifarişlər" ], "operationId": "orders", "summary": "Sifariş tarixçəsini al", "description": "Cari API istifadəçisinin sifarişlərini qaytarır.\n\nMüştəri yalnız öz sifarişlərini görə bilər.", "parameters": [ { "name": "status", "in": "query", "required": false, "description": "Sifariş statusu.", "schema": { "type": "string", "enum": [ "pending", "processing", "completed", "failed", "canceled", "cancelled", "refunded" ], "example": "completed" } }, { "name": "type", "in": "query", "required": false, "description": "Məhsul tipi.", "schema": { "type": "string", "enum": [ "voucher", "topup" ], "example": "voucher" } }, { "name": "page", "in": "query", "required": false, "description": "Səhifə nömrəsi.", "schema": { "type": "integer", "example": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Səhifə ölçüsü. Maksimum 100.", "schema": { "type": "integer", "example": 50 } } ], "responses": { "200": { "description": "Cari API istifadəçisinin sifarişlərini qaytarır.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object", "properties": { "order_id": { "type": "integer", "example": 8821 }, "product_name": { "type": "string", "example": "Steam Wallet 10 USD" }, "product_type": { "type": "string", "example": "VOUCHER" }, "qty": { "type": "integer", "example": 1 }, "status": { "type": "string", "example": "COMPLETED" }, "price": { "type": "string", "example": "9.9900" }, "currency": { "type": "string", "example": "USD" }, "delivery": { "type": "array", "items": { "type": "string", "example": "CODE-ONE-XXXX" }, "example": [ "CODE-ONE-XXXX" ] }, "manual_action_required": { "type": "boolean", "example": false }, "delivery_message": { "type": [ "string", "null" ] } }, "example": { "order_id": 8821, "product_name": "Steam Wallet 10 USD", "product_type": "VOUCHER", "qty": 1, "status": "COMPLETED", "price": "9.9900", "currency": "USD", "delivery": [ "CODE-ONE-XXXX" ], "manual_action_required": false, "delivery_message": null }, "additionalProperties": true }, "example": [ { "order_id": 8821, "product_name": "Steam Wallet 10 USD", "product_type": "VOUCHER", "qty": 1, "status": "COMPLETED", "price": "9.9900", "currency": "USD", "delivery": [ "CODE-ONE-XXXX" ], "manual_action_required": false, "delivery_message": null } ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 1 }, "per_page": { "type": "integer", "example": 50 }, "total": { "type": "integer", "example": 1 } }, "example": { "current_page": 1, "last_page": 1, "per_page": 50, "total": 1 }, "additionalProperties": true } }, "example": { "success": true, "data": [ { "order_id": 8821, "product_name": "Steam Wallet 10 USD", "product_type": "VOUCHER", "qty": 1, "status": "COMPLETED", "price": "9.9900", "currency": "USD", "delivery": [ "CODE-ONE-XXXX" ], "manual_action_required": false, "delivery_message": null } ], "meta": { "current_page": 1, "last_page": 1, "per_page": 50, "total": 1 } }, "additionalProperties": true }, "example": { "success": true, "data": [ { "order_id": 8821, "product_name": "Steam Wallet 10 USD", "product_type": "VOUCHER", "qty": 1, "status": "COMPLETED", "price": "9.9900", "currency": "USD", "delivery": [ "CODE-ONE-XXXX" ], "manual_action_required": false, "delivery_message": null } ], "meta": { "current_page": 1, "last_page": 1, "per_page": 50, "total": 1 } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "422": { "description": "Filtr və ya səhifələmə parametri yanlışdır.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "VALIDATION_ERROR": { "value": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Filtr və ya səhifələmə parametri yanlışdır." } } } } } } } } } }, "/redeem-check": { "post": { "tags": [ "Kod yoxlaması" ], "operationId": "redeem_check", "summary": "Kodun istifadə məlumatını yoxla", "description": "Kodu yoxlayır və nəticəyə uyğun məbləği balansdan tutur.\n\nBu sorğu faktiki balans əməliyyatı yarada bilər.", "parameters": [ { "name": "X-Idempotency-Key", "in": "header", "required": true, "description": "Məcburi unikal təkrar cəhd açarı. Eyni kodla təkrar istifadə edilərsə əvvəlki nəticə qaytarılır, ikinci dəfə balans tutulmur və yuxarı səviyyəli xidmətə yeni yoxlama sorğusu göndərilmir.", "schema": { "type": "string", "example": "4d83ae61-b98b-4d4d-bf11-58f3bc028a71" } } ], "responses": { "200": { "description": "Kodu yoxlayır və nəticəyə uyğun məbləği balansdan tutur.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 142 }, "status": { "type": "string", "example": "found" }, "code_masked": { "type": "string", "example": "REDE********MPLE" }, "charged_amount": { "type": "string", "example": "0.0500" }, "charged_amount_text": { "type": "string", "example": "$ 0.05" }, "balance": { "type": "string", "example": "1250.4500" }, "balance_text": { "type": "string", "example": "$ 1250.45" }, "currency_code": { "type": "string", "example": "USD" }, "currency_symbol": { "type": "string", "example": "$" }, "redemption_time": { "type": "string", "example": "2026-07-25 13:30:00" }, "expiration_time": { "type": [ "string", "null" ] }, "amount": { "type": "integer", "example": 60 }, "product_name": { "type": "string", "example": "PUBG Mobile 60 UC" }, "player_id": { "type": "string", "example": "51515969536" }, "player_name": { "type": "string", "example": "PlayerOne" }, "created_at": { "type": "string", "example": "2026-07-25 13:30:02" } }, "example": { "id": 142, "status": "found", "code_masked": "REDE********MPLE", "charged_amount": "0.0500", "charged_amount_text": "$ 0.05", "balance": "1250.4500", "balance_text": "$ 1250.45", "currency_code": "USD", "currency_symbol": "$", "redemption_time": "2026-07-25 13:30:00", "expiration_time": null, "amount": 60, "product_name": "PUBG Mobile 60 UC", "player_id": "51515969536", "player_name": "PlayerOne", "created_at": "2026-07-25 13:30:02" }, "additionalProperties": true }, "meta": { "type": "object", "properties": { "idempotent_replay": { "type": "boolean", "example": false } }, "example": { "idempotent_replay": false }, "additionalProperties": true } }, "example": { "success": true, "data": { "id": 142, "status": "found", "code_masked": "REDE********MPLE", "charged_amount": "0.0500", "charged_amount_text": "$ 0.05", "balance": "1250.4500", "balance_text": "$ 1250.45", "currency_code": "USD", "currency_symbol": "$", "redemption_time": "2026-07-25 13:30:00", "expiration_time": null, "amount": 60, "product_name": "PUBG Mobile 60 UC", "player_id": "51515969536", "player_name": "PlayerOne", "created_at": "2026-07-25 13:30:02" }, "meta": { "idempotent_replay": false } }, "additionalProperties": true }, "example": { "success": true, "data": { "id": 142, "status": "found", "code_masked": "REDE********MPLE", "charged_amount": "0.0500", "charged_amount_text": "$ 0.05", "balance": "1250.4500", "balance_text": "$ 1250.45", "currency_code": "USD", "currency_symbol": "$", "redemption_time": "2026-07-25 13:30:00", "expiration_time": null, "amount": 60, "product_name": "PUBG Mobile 60 UC", "player_id": "51515969536", "player_name": "PlayerOne", "created_at": "2026-07-25 13:30:02" }, "meta": { "idempotent_replay": false } } } } }, "503": { "description": "Public API admin tərəfindən deaktiv edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_DISABLED": { "value": { "success": false, "error": { "code": "API_DISABLED", "message": "Public API admin tərəfindən deaktiv edilib." } } } } } } }, "401": { "description": "X-API-KEY başlığı göndərilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "API_KEY_MISSING": { "value": { "success": false, "error": { "code": "API_KEY_MISSING", "message": "X-API-KEY başlığı göndərilməyib." } } }, "INVALID_API_KEY": { "value": { "success": false, "error": { "code": "INVALID_API_KEY", "message": "API açarı yanlışdır, passivdir və ya müştəri passivdir." } } } } } } }, "403": { "description": "Sorğu edən IP ünvanına icazə verilməyib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IP_NOT_ALLOWED": { "value": { "success": false, "error": { "code": "IP_NOT_ALLOWED", "message": "Sorğu edən IP ünvanına icazə verilməyib." } } } } } } }, "429": { "description": "Dəqiqəlik sorğu limiti keçilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "RATE_LIMIT_EXCEEDED": { "value": { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Dəqiqəlik sorğu limiti keçilib." } } } } } } }, "422": { "description": "Bu əməliyyat üçün stabil idempotency açarı tələb olunur.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IDEMPOTENCY_KEY_REQUIRED": { "value": { "success": false, "error": { "code": "IDEMPOTENCY_KEY_REQUIRED", "message": "Bu əməliyyat üçün stabil idempotency açarı tələb olunur." } } }, "IDEMPOTENCY_KEY_INVALID": { "value": { "success": false, "error": { "code": "IDEMPOTENCY_KEY_INVALID", "message": "Idempotency açarı yanlışdır və ya 128 simvoldan uzundur." } } }, "VALIDATION_ERROR": { "value": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Kod göndərilməyib və ya uzunluğu yanlışdır." } } }, "REDEEM_CHECK_FAILED": { "value": { "success": false, "error": { "code": "REDEEM_CHECK_FAILED", "message": "Kod yoxlaması uğursuz oldu." } } } } } } }, "409": { "description": "Eyni açar fərqli sorğu ilə istifadə edilib.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "IDEMPOTENCY_CONFLICT": { "value": { "success": false, "error": { "code": "IDEMPOTENCY_CONFLICT", "message": "Eyni açar fərqli sorğu ilə istifadə edilib." } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "REDEEM-CODE-EXAMPLE", "description": "Yoxlanılacaq kod. 6-160 simvol." } }, "additionalProperties": false, "required": [ "code" ] }, "example": { "code": "REDEEM-CODE-EXAMPLE" } } } } } } }, "webhooks": { "orderStatusChanged": { "post": { "summary": "Webhook çatdırılması", "description": "Bu sorğu platformanın callback_url ünvanınıza göndərdiyi məlumat paketini təmsil edir. Qəbulediciniz HMAC imzasını yoxlamalı, event_id-ni idempotent şəkildə emal etməli və sürətlə 2xx cavabı qaytarmalıdır.", "security": [], "parameters": [ { "name": "X-EPINBULK-Signature-V2", "in": "header", "required": true, "description": "Tövsiyə edilən: sha256=HMAC_SHA256(timestamp + \".\" + event_id + \".\" + xam_json_gövdesi, webhook_məxfi_açarı). Yuxarıda göstərilən timestamp və event-id başlıqlarından istifadə edin.", "schema": { "type": "string" } }, { "name": "X-EPINBULK-Signature-Version", "in": "header", "required": true, "description": "2", "schema": { "type": "string" } }, { "name": "X-EPINBULK-Signature", "in": "header", "required": true, "description": "sha256=HMAC_SHA256(xam_json_gövdesi, webhook_məxfi_açarı)", "schema": { "type": "string" } }, { "name": "X-EPINBULK-Timestamp", "in": "header", "required": true, "description": "ISO-8601 webhook göndərilmə vaxtı. V2 imzanı yoxlayarkən vaxtın təzəliyini də yoxlayın.", "schema": { "type": "string" } }, { "name": "X-EPINBULK-Event-Id", "in": "header", "required": true, "description": "Unikal hadisə UUID-si.", "schema": { "type": "string" } }, { "name": "X-EPINBULK-Event", "in": "header", "required": true, "description": "Actual event name: order.status_changed or qr_login.*", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "examples": { "legacy": { "value": { "event_id": "47c8c6ba-16a5-4089-9f62-7ae1e51d4c0f", "order_id": 8821, "client_order_id": "order-10001", "status": "COMPLETED", "product_name": "Steam Wallet 10 USD", "qty": 2, "player_id": null, "player_name": null, "server_id": null, "region": null, "price": "19.9800", "currency": "USD", "delivery": [ "CODE-ONE-XXXX", "CODE-TWO-XXXX" ], "manual_action_required": false, "delivery_message": null, "timestamp": "2026-07-25T13:31:10+04:00" } }, "events": { "value": { "event_id": "47c8c6ba-16a5-4089-9f62-7ae1e51d4c0f", "event": "order.status_changed", "callback_mode": "events", "order_id": 8821, "client_order_id": "order-10001", "product_id": 91, "product_name": "PUBG Mobile 60 UC", "product_type": "TOPUP", "game_id": 1, "game_name": "PUBG Mobile", "player_id": "51515969536", "player_name": "PlayerOne", "server_id": "1234", "region": "TR", "qty": 1, "price": "0.8800", "currency": "USD", "delivery": [], "manual_action_required": false, "delivery_message": null, "status": "COMPLETED", "message": "Sifariş uğurla tamamlandı.", "timestamp": "2026-07-25T13:30:10+04:00" } } } } } }, "responses": { "204": { "description": "Webhook accepted" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY" } }, "schemas": { "Error": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "message": { "type": "string", "example": "product_id sahəsi məcburidir." }, "details": { "type": "object", "properties": { "max": { "type": "integer", "example": 1 } }, "example": { "max": 1 }, "additionalProperties": true } }, "example": { "code": "VALIDATION_ERROR", "message": "product_id sahəsi məcburidir.", "details": { "max": 1 } }, "additionalProperties": true } }, "example": { "success": false, "error": { "code": "VALIDATION_ERROR", "message": "product_id sahəsi məcburidir.", "details": { "max": 1 } } }, "additionalProperties": true } } }, "x-public-api-idempotency-header": "X-Idempotency-Key", "x-public-api-request-id-header": "X-Request-Id", "x-public-api-status-lifecycle": [ { "status": "PENDING", "terminal": false, "description": "Sifariş emal gözləyir." }, { "status": "PROCESSING", "terminal": false, "description": "Sifariş emal olunur." }, { "status": "COMPLETED", "terminal": true, "description": "Sifariş tamamlanıb." }, { "status": "FAILED", "terminal": true, "description": "Sifariş uğursuz olub." }, { "status": "CANCELED", "terminal": true, "description": "Sifariş ləğv edilib." }, { "status": "REFUNDED", "terminal": true, "description": "Məbləğ geri qaytarılıb." } ], "x-public-api-webhook-policy": { "event": "order.status_changed", "events": [ "order.status_changed", "qr_login.waiting_worker", "qr_login.worker_assigned", "qr_login.qr_ready", "qr_login.customer_scanned", "qr_login.new_qr_requested", "qr_login.otp_required", "qr_login.otp_submitted" ], "method": "POST", "content_type": "application/json", "headers": [ { "name": "X-EPINBULK-Signature-V2", "description": "Tövsiyə edilən: sha256=HMAC_SHA256(timestamp + \".\" + event_id + \".\" + xam_json_gövdesi, webhook_məxfi_açarı). Yuxarıda göstərilən timestamp və event-id başlıqlarından istifadə edin." }, { "name": "X-EPINBULK-Signature-Version", "description": "2" }, { "name": "X-EPINBULK-Signature", "description": "sha256=HMAC_SHA256(xam_json_gövdesi, webhook_məxfi_açarı)" }, { "name": "X-EPINBULK-Timestamp", "description": "ISO-8601 webhook göndərilmə vaxtı. V2 imzanı yoxlayarkən vaxtın təzəliyini də yoxlayın." }, { "name": "X-EPINBULK-Event-Id", "description": "Unikal hadisə UUID-si." }, { "name": "X-EPINBULK-Event", "description": "Actual event name: order.status_changed or qr_login.*" } ], "requirements": [ "Yalnız HTTPS URL qəbul edilir.", "Yalnız 443 portu qəbul edilir.", "Şəxsi və yerli ünvanlar bloklanır.", "URL daxilində giriş məlumatı qəbul edilmir.", "Yönləndirmələr izlənmir.", "Server 2xx cavab qaytarmalıdır." ], "retry_schedule": [ "1 → 1 dəqiqə", "2 → 5 dəqiqə", "3 → 15 dəqiqə", "4-6 → 60 dəqiqə", "7-20 → 6 saat" ], "max_attempts": 20, "legacy_example": { "event_id": "47c8c6ba-16a5-4089-9f62-7ae1e51d4c0f", "order_id": 8821, "client_order_id": "order-10001", "status": "COMPLETED", "product_name": "Steam Wallet 10 USD", "qty": 2, "player_id": null, "player_name": null, "server_id": null, "region": null, "price": "19.9800", "currency": "USD", "delivery": [ "CODE-ONE-XXXX", "CODE-TWO-XXXX" ], "manual_action_required": false, "delivery_message": null, "timestamp": "2026-07-25T13:31:10+04:00" }, "events_example": { "event_id": "47c8c6ba-16a5-4089-9f62-7ae1e51d4c0f", "event": "order.status_changed", "callback_mode": "events", "order_id": 8821, "client_order_id": "order-10001", "product_id": 91, "product_name": "PUBG Mobile 60 UC", "product_type": "TOPUP", "game_id": 1, "game_name": "PUBG Mobile", "player_id": "51515969536", "player_name": "PlayerOne", "server_id": "1234", "region": "TR", "qty": 1, "price": "0.8800", "currency": "USD", "delivery": [], "manual_action_required": false, "delivery_message": null, "status": "COMPLETED", "message": "Sifariş uğurla tamamlandı.", "timestamp": "2026-07-25T13:30:10+04:00" } }, "x-public-api-limits": { "max_per_page": 100, "max_voucher_qty": 500, "max_topup_qty": 1, "default_callback_mode": "legacy" } }