{
    "openapi": "3.1.0",
    "info": {
        "title": "PayPardakht API",
        "version": "1.0.0",
        "description": "API یکپارچه استعلام‌های PayPardakht برای محیط Sandbox و Live."
    },
    "servers": [
        {
            "url": "https://paypardakht.ir",
            "description": "PayPardakht"
        }
    ],
    "paths": {
        "/api/v1/identity-cases": {
            "post": {
                "operationId": "openIdentityCase",
                "summary": "ایجاد یا بازیابی پرونده",
                "security": [
                    {
                        "bearerAuth": []
                    }
                ],
                "parameters": [],
                "responses": {
                    "200": {
                        "description": "رسید پرونده شامل مراحل، سابقه و هزینه‌ها"
                    },
                    "401": {
                        "description": "کلید API معتبر لازم است"
                    },
                    "404": {
                        "description": "پرونده یا استعلام در پروژهٔ جاری یافت نشد"
                    },
                    "409": {
                        "description": "مرحله، موضوع یا وضعیت پرونده با درخواست سازگار نیست"
                    },
                    "422": {
                        "description": "خطای اعتبارسنجی"
                    },
                    "429": {
                        "description": "سقف نرخ درخواست پروژه"
                    },
                    "201": {
                        "description": "پرونده ایجاد شد"
                    }
                },
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "required": [
                                    "client_reference"
                                ],
                                "properties": {
                                    "client_reference": {
                                        "type": "string",
                                        "maxLength": 64
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/api/v1/identity-cases/{case}": {
            "get": {
                "operationId": "getIdentityCase",
                "summary": "رسید و وضعیت پرونده",
                "security": [
                    {
                        "bearerAuth": []
                    }
                ],
                "parameters": [
                    {
                        "name": "case",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "رسید پرونده شامل مراحل، سابقه و هزینه‌ها"
                    },
                    "401": {
                        "description": "کلید API معتبر لازم است"
                    },
                    "404": {
                        "description": "پرونده یا استعلام در پروژهٔ جاری یافت نشد"
                    },
                    "409": {
                        "description": "مرحله، موضوع یا وضعیت پرونده با درخواست سازگار نیست"
                    },
                    "422": {
                        "description": "خطای اعتبارسنجی"
                    },
                    "429": {
                        "description": "سقف نرخ درخواست پروژه"
                    }
                }
            }
        },
        "/api/v1/identity-cases/{case}/inquiries": {
            "post": {
                "operationId": "attachIdentityInquiry",
                "summary": "پیوند استعلام همان پروژه",
                "security": [
                    {
                        "bearerAuth": []
                    }
                ],
                "parameters": [
                    {
                        "name": "case",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "رسید پرونده شامل مراحل، سابقه و هزینه‌ها"
                    },
                    "401": {
                        "description": "کلید API معتبر لازم است"
                    },
                    "404": {
                        "description": "پرونده یا استعلام در پروژهٔ جاری یافت نشد"
                    },
                    "409": {
                        "description": "مرحله، موضوع یا وضعیت پرونده با درخواست سازگار نیست"
                    },
                    "422": {
                        "description": "خطای اعتبارسنجی"
                    },
                    "429": {
                        "description": "سقف نرخ درخواست پروژه"
                    }
                },
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "required": [
                                    "tracking_code"
                                ],
                                "properties": {
                                    "tracking_code": {
                                        "type": "string",
                                        "maxLength": 80
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/api/v1/inquiries/{tracking_code}": {
            "get": {
                "summary": "دریافت وضعیت و نتیجه استعلام",
                "operationId": "getInquiry",
                "security": [
                    {
                        "bearerAuth": []
                    }
                ],
                "parameters": [
                    {
                        "name": "tracking_code",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "نتیجه نهایی"
                    },
                    "202": {
                        "description": "در حال پردازش"
                    },
                    "404": {
                        "description": "استعلام در پروژهٔ جاری یافت نشد"
                    },
                    "401": {
                        "description": "کلید API نامعتبر"
                    }
                }
            }
        }
    },
    "components": {
        "securitySchemes": {
            "bearerAuth": {
                "type": "http",
                "scheme": "bearer",
                "bearerFormat": "API Key"
            }
        }
    }
}