@djangocfg/ext-payments 1.0.0

package/src/api/generated/ext_payments/schema.json

@@ -0,0 +1,850 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Django CFG API",
+    "version": "1.0.0",
+    "description": "Complete API documentation for Django CFG Demo Project",
+    "x-django-metadata": {
+      "group": "ext_payments",
+      "apps": [
+        "ext_payments"
+      ],
+      "generator": "django-client",
+      "generator_version": "1.0.0"
+    }
+  },
+  "paths": {
+    "/cfg/payments/balance/": {
+      "get": {
+        "operationId": "cfg_payments_balance_retrieve",
+        "description": "Get current user balance and transaction statistics",
+        "summary": "Get user balance",
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Balance"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/currencies/": {
+      "get": {
+        "operationId": "cfg_payments_currencies_list",
+        "description": "Returns list of available currencies with token+network info",
+        "summary": "Get available currencies",
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Currency"
+                  }
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/payments/": {
+      "get": {
+        "operationId": "cfg_payments_payments_list",
+        "description": "ViewSet for payment operations.\n\nEndpoints:\n- GET /payments/ - List user's payments\n- GET /payments/{id}/ - Get payment details\n- POST /payments/create/ - Create new payment\n- GET /payments/{id}/status/ - Check payment status\n- POST /payments/{id}/confirm/ - Confirm payment",
+        "parameters": [
+          {
+            "name": "page",
+            "required": false,
+            "in": "query",
+            "description": "A page number within the paginated result set.",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "page_size",
+            "required": false,
+            "in": "query",
+            "description": "Number of results to return per page.",
+            "schema": {
+              "type": "integer"
+            }
+          }
+        ],
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaginatedPaymentListList"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/payments/{id}/": {
+      "get": {
+        "operationId": "cfg_payments_payments_retrieve",
+        "description": "ViewSet for payment operations.\n\nEndpoints:\n- GET /payments/ - List user's payments\n- GET /payments/{id}/ - Get payment details\n- POST /payments/create/ - Create new payment\n- GET /payments/{id}/status/ - Check payment status\n- POST /payments/{id}/confirm/ - Confirm payment",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaymentDetail"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/payments/{id}/confirm/": {
+      "post": {
+        "operationId": "cfg_payments_payments_confirm_create",
+        "description": "POST /api/v1/payments/{id}/confirm/\n\nConfirm payment (user clicked \"I have paid\").\nChecks status with provider and creates transaction if completed.",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaymentList"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/payments/{id}/status/": {
+      "get": {
+        "operationId": "cfg_payments_payments_status_retrieve",
+        "description": "GET /api/v1/payments/{id}/status/?refresh=true\n\nCheck payment status (with optional refresh from provider).\n\nQuery params:\n- refresh: boolean (default: false) - Force refresh from provider",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaymentList"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/payments/create/": {
+      "post": {
+        "operationId": "cfg_payments_payments_create_create",
+        "description": "POST /api/v1/payments/create/\n\nCreate new payment.\n\nRequest body:\n{\n    \"amount_usd\": \"100.00\",\n    \"currency_code\": \"USDTTRC20\",\n    \"description\": \"Optional description\"\n}",
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PaymentList"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/transactions/": {
+      "get": {
+        "operationId": "cfg_payments_transactions_list",
+        "description": "Get user transactions with pagination and filtering",
+        "summary": "Get user transactions",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "limit",
+            "schema": {
+              "type": "integer"
+            },
+            "description": "Number of transactions to return (max 100)"
+          },
+          {
+            "in": "query",
+            "name": "offset",
+            "schema": {
+              "type": "integer"
+            },
+            "description": "Offset for pagination"
+          },
+          {
+            "in": "query",
+            "name": "type",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Filter by transaction type (deposit/withdrawal)"
+          }
+        ],
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Transaction"
+                  }
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Balance": {
+        "type": "object",
+        "description": "User balance serializer.",
+        "properties": {
+          "balance_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Current balance in USD"
+          },
+          "balance_display": {
+            "type": "string",
+            "readOnly": true
+          },
+          "total_deposited": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Total amount deposited (lifetime)"
+          },
+          "total_withdrawn": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Total amount withdrawn (lifetime)"
+          },
+          "last_transaction_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true,
+            "description": "When the last transaction occurred"
+          }
+        },
+        "required": [
+          "balance_display",
+          "balance_usd",
+          "last_transaction_at",
+          "total_deposited",
+          "total_withdrawn"
+        ]
+      },
+      "Currency": {
+        "type": "object",
+        "description": "Currency list serializer.",
+        "properties": {
+          "code": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Currency code from provider (e.g., USDTTRC20, BTC, ETH)"
+          },
+          "name": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Full currency name (e.g., USDT (TRC20), Bitcoin)"
+          },
+          "token": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Token symbol (e.g., USDT, BTC, ETH)"
+          },
+          "network": {
+            "type": "string",
+            "readOnly": true,
+            "nullable": true,
+            "description": "Network name (e.g., TRC20, ERC20, Bitcoin)"
+          },
+          "display_name": {
+            "type": "string",
+            "readOnly": true
+          },
+          "symbol": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Currency symbol (e.g., ₮, ₿, Ξ)"
+          },
+          "decimal_places": {
+            "type": "integer",
+            "readOnly": true,
+            "description": "Number of decimal places for this currency"
+          },
+          "is_active": {
+            "type": "boolean",
+            "readOnly": true,
+            "description": "Whether this currency is available for payments"
+          },
+          "min_amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Minimum payment amount in USD"
+          },
+          "sort_order": {
+            "type": "integer",
+            "readOnly": true,
+            "description": "Sort order for currency list (lower = higher priority)"
+          }
+        },
+        "required": [
+          "code",
+          "decimal_places",
+          "display_name",
+          "is_active",
+          "min_amount_usd",
+          "name",
+          "network",
+          "sort_order",
+          "symbol",
+          "token"
+        ]
+      },
+      "PaginatedPaymentListList": {
+        "type": "object",
+        "required": [
+          "count",
+          "page",
+          "pages",
+          "page_size",
+          "has_next",
+          "has_previous",
+          "results"
+        ],
+        "properties": {
+          "count": {
+            "type": "integer",
+            "description": "Total number of items across all pages",
+            "example": 150
+          },
+          "page": {
+            "type": "integer",
+            "description": "Current page number (1-based)",
+            "example": 2
+          },
+          "pages": {
+            "type": "integer",
+            "description": "Total number of pages",
+            "example": 15
+          },
+          "page_size": {
+            "type": "integer",
+            "description": "Number of items per page",
+            "example": 10
+          },
+          "has_next": {
+            "type": "boolean",
+            "description": "Whether there is a next page",
+            "example": true
+          },
+          "has_previous": {
+            "type": "boolean",
+            "description": "Whether there is a previous page",
+            "example": true
+          },
+          "next_page": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Next page number (null if no next page)",
+            "example": 3
+          },
+          "previous_page": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Previous page number (null if no previous page)",
+            "example": 1
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/PaymentList"
+            },
+            "description": "Array of items for current page"
+          }
+        }
+      },
+      "PaymentDetail": {
+        "type": "object",
+        "description": "Detailed payment information.",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "readOnly": true,
+            "description": "Unique identifier for this record"
+          },
+          "internal_payment_id": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Internal payment identifier (PAY_YYYYMMDDHHMMSS_UUID)"
+          },
+          "amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Payment amount in USD"
+          },
+          "currency_code": {
+            "type": "string",
+            "readOnly": true
+          },
+          "currency_name": {
+            "type": "string",
+            "readOnly": true
+          },
+          "currency_token": {
+            "type": "string",
+            "readOnly": true
+          },
+          "currency_network": {
+            "type": "string",
+            "readOnly": true
+          },
+          "pay_amount": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,12}(?:\\.\\d{0,8})?$",
+            "readOnly": true,
+            "nullable": true,
+            "description": "Amount to pay in cryptocurrency"
+          },
+          "actual_amount": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,12}(?:\\.\\d{0,8})?$",
+            "readOnly": true,
+            "nullable": true,
+            "description": "Actual amount received in cryptocurrency"
+          },
+          "actual_amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "nullable": true,
+            "description": "Actual amount received in USD"
+          },
+          "status": {
+            "enum": [
+              "pending",
+              "confirming",
+              "confirmed",
+              "completed",
+              "partially_paid",
+              "failed",
+              "expired",
+              "cancelled"
+            ],
+            "type": "string",
+            "x-spec-enum-id": "19926dfeb2f474a4",
+            "readOnly": true,
+            "description": "Current payment status\n\n* `pending` - Pending\n* `confirming` - Confirming\n* `confirmed` - Confirmed\n* `completed` - Completed\n* `partially_paid` - Partially Paid\n* `failed` - Failed\n* `expired` - Expired\n* `cancelled` - Cancelled"
+          },
+          "status_display": {
+            "type": "string",
+            "readOnly": true
+          },
+          "pay_address": {
+            "type": "string",
+            "readOnly": true,
+            "nullable": true,
+            "description": "Cryptocurrency payment address"
+          },
+          "qr_code_url": {
+            "type": "string",
+            "nullable": true,
+            "description": "Get QR code URL.",
+            "readOnly": true
+          },
+          "payment_url": {
+            "type": "string",
+            "format": "uri",
+            "readOnly": true,
+            "nullable": true,
+            "description": "Payment page URL (if provided by provider)"
+          },
+          "transaction_hash": {
+            "type": "string",
+            "readOnly": true,
+            "nullable": true,
+            "description": "Blockchain transaction hash"
+          },
+          "explorer_link": {
+            "type": "string",
+            "nullable": true,
+            "description": "Get blockchain explorer link.",
+            "readOnly": true
+          },
+          "confirmations_count": {
+            "type": "integer",
+            "readOnly": true,
+            "description": "Number of blockchain confirmations"
+          },
+          "expires_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true,
+            "description": "When this payment expires (typically 30 minutes)"
+          },
+          "completed_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true,
+            "description": "When this payment was completed"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "description": "When this record was created"
+          },
+          "is_completed": {
+            "type": "boolean",
+            "readOnly": true
+          },
+          "is_failed": {
+            "type": "boolean",
+            "readOnly": true
+          },
+          "is_expired": {
+            "type": "boolean",
+            "readOnly": true
+          },
+          "description": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Payment description"
+          }
+        },
+        "required": [
+          "actual_amount",
+          "actual_amount_usd",
+          "amount_usd",
+          "completed_at",
+          "confirmations_count",
+          "created_at",
+          "currency_code",
+          "currency_name",
+          "currency_network",
+          "currency_token",
+          "description",
+          "expires_at",
+          "explorer_link",
+          "id",
+          "internal_payment_id",
+          "is_completed",
+          "is_expired",
+          "is_failed",
+          "pay_address",
+          "pay_amount",
+          "payment_url",
+          "qr_code_url",
+          "status",
+          "status_display",
+          "transaction_hash"
+        ]
+      },
+      "PaymentList": {
+        "type": "object",
+        "description": "Payment list item (lighter than detail).",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "readOnly": true,
+            "description": "Unique identifier for this record"
+          },
+          "internal_payment_id": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Internal payment identifier (PAY_YYYYMMDDHHMMSS_UUID)"
+          },
+          "amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Payment amount in USD"
+          },
+          "currency_code": {
+            "type": "string",
+            "readOnly": true
+          },
+          "currency_token": {
+            "type": "string",
+            "readOnly": true
+          },
+          "status": {
+            "enum": [
+              "pending",
+              "confirming",
+              "confirmed",
+              "completed",
+              "partially_paid",
+              "failed",
+              "expired",
+              "cancelled"
+            ],
+            "type": "string",
+            "x-spec-enum-id": "19926dfeb2f474a4",
+            "readOnly": true,
+            "description": "Current payment status\n\n* `pending` - Pending\n* `confirming` - Confirming\n* `confirmed` - Confirmed\n* `completed` - Completed\n* `partially_paid` - Partially Paid\n* `failed` - Failed\n* `expired` - Expired\n* `cancelled` - Cancelled"
+          },
+          "status_display": {
+            "type": "string",
+            "readOnly": true
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "description": "When this record was created"
+          },
+          "completed_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true,
+            "description": "When this payment was completed"
+          }
+        },
+        "required": [
+          "amount_usd",
+          "completed_at",
+          "created_at",
+          "currency_code",
+          "currency_token",
+          "id",
+          "internal_payment_id",
+          "status",
+          "status_display"
+        ]
+      },
+      "Transaction": {
+        "type": "object",
+        "description": "Transaction serializer.",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "readOnly": true,
+            "description": "Unique identifier for this record"
+          },
+          "transaction_type": {
+            "enum": [
+              "deposit",
+              "withdrawal",
+              "payment",
+              "refund",
+              "fee",
+              "bonus",
+              "adjustment"
+            ],
+            "type": "string",
+            "x-spec-enum-id": "1089b7b698dd0a5e",
+            "readOnly": true,
+            "description": "Type of transaction\n\n* `deposit` - Deposit\n* `withdrawal` - Withdrawal\n* `payment` - Payment\n* `refund` - Refund\n* `fee` - Fee\n* `bonus` - Bonus\n* `adjustment` - Adjustment"
+          },
+          "type_display": {
+            "type": "string",
+            "readOnly": true
+          },
+          "amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Transaction amount in USD (positive=credit, negative=debit)"
+          },
+          "amount_display": {
+            "type": "string",
+            "readOnly": true
+          },
+          "balance_after": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "User balance after this transaction"
+          },
+          "payment_id": {
+            "type": "string",
+            "readOnly": true,
+            "nullable": true,
+            "description": "Related payment ID (if applicable)"
+          },
+          "description": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Transaction description"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "description": "When this record was created"
+          }
+        },
+        "required": [
+          "amount_display",
+          "amount_usd",
+          "balance_after",
+          "created_at",
+          "description",
+          "id",
+          "payment_id",
+          "transaction_type",
+          "type_display"
+        ]
+      }
+    },
+    "securitySchemes": {
+      "jwtAuthWithLastLogin": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      }
+    }
+  },
+  "servers": [
+    {
+      "url": "http://localhost:8000"
+    }
+  ]
+}