@djangocfg/ext-payments 1.0.14 → 1.0.19

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

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "title": "Django CFG API",
+    "title": "Cmdop API",
     "version": "1.0.0",
     "description": "Complete API documentation for Django CFG Demo Project",
     "x-django-metadata": {
@@ -45,7 +45,7 @@
     "/cfg/payments/currencies/": {
       "get": {
         "operationId": "cfg_payments_currencies_list",
-        "description": "Returns list of available currencies with token+network info",
+        "description": "Returns list of available currencies with token+network info, popular first",
         "summary": "Get available currencies",
         "tags": [
           "payments"
@@ -73,6 +73,92 @@
         "x-async-capable": false
       }
     },
+    "/cfg/payments/currencies/{code}/estimate/": {
+      "get": {
+        "operationId": "cfg_payments_currencies_estimate_retrieve",
+        "description": "Get estimated crypto amount for a given USD amount, including min amount",
+        "summary": "Get currency estimate",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "amount",
+            "schema": {
+              "type": "number",
+              "format": "double"
+            },
+            "description": "Amount in USD (default: 1)"
+          },
+          {
+            "in": "path",
+            "name": "code",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Estimate response"
+          },
+          "400": {
+            "description": "Invalid currency"
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/currencies/{code}/withdrawal-estimate/": {
+      "get": {
+        "operationId": "cfg_payments_currencies_withdrawal_estimate_retrieve",
+        "description": "Get estimated crypto amount for withdrawal with fee breakdown",
+        "summary": "Get withdrawal estimate",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "amount",
+            "schema": {
+              "type": "number",
+              "format": "double"
+            },
+            "description": "Amount to withdraw in USD (default: 10)"
+          },
+          {
+            "in": "path",
+            "name": "code",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Withdrawal estimate response"
+          },
+          "400": {
+            "description": "Invalid currency or amount"
+          }
+        },
+        "x-async-capable": false
+      }
+    },
     "/cfg/payments/payments/": {
       "get": {
         "operationId": "cfg_payments_payments_list",
@@ -234,25 +320,49 @@
     "/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}",
+        "description": "Create a new payment with specified amount and currency",
+        "summary": "Create payment",
         "tags": [
           "payments"
         ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PaymentCreateRequest"
+              }
+            },
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "$ref": "#/components/schemas/PaymentCreateRequest"
+              }
+            },
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/PaymentCreateRequest"
+              }
+            }
+          },
+          "required": true
+        },
         "security": [
           {
             "jwtAuthWithLastLogin": []
           }
         ],
         "responses": {
-          "200": {
+          "201": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/PaymentList"
+                  "$ref": "#/components/schemas/PaymentCreateResponse"
                 }
               }
             },
             "description": ""
+          },
+          "400": {
+            "description": "Validation error"
           }
         },
         "x-async-capable": false
@@ -314,6 +424,182 @@
         },
         "x-async-capable": false
       }
+    },
+    "/cfg/payments/withdrawals/": {
+      "get": {
+        "operationId": "cfg_payments_withdrawals_list",
+        "description": "ViewSet for withdrawal operations.\n\nEndpoints:\n- GET /withdrawals/ - List user's withdrawal requests\n- GET /withdrawals/{id}/ - Get withdrawal details\n- POST /withdrawals/create/ - Create withdrawal request\n- POST /withdrawals/{id}/cancel/ - Cancel pending withdrawal",
+        "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/PaginatedWithdrawalListList"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/withdrawals/{id}/": {
+      "get": {
+        "operationId": "cfg_payments_withdrawals_retrieve",
+        "description": "ViewSet for withdrawal operations.\n\nEndpoints:\n- GET /withdrawals/ - List user's withdrawal requests\n- GET /withdrawals/{id}/ - Get withdrawal details\n- POST /withdrawals/create/ - Create withdrawal request\n- POST /withdrawals/{id}/cancel/ - Cancel pending withdrawal",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/WithdrawalDetail"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/withdrawals/{id}/cancel/": {
+      "post": {
+        "operationId": "cfg_payments_withdrawals_cancel_create",
+        "description": "Cancel a pending withdrawal request",
+        "summary": "Cancel withdrawal request",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "payments"
+        ],
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/WithdrawalCancelResponse"
+                }
+              }
+            },
+            "description": ""
+          },
+          "400": {
+            "description": "Cannot cancel"
+          }
+        },
+        "x-async-capable": false
+      }
+    },
+    "/cfg/payments/withdrawals/create/": {
+      "post": {
+        "operationId": "cfg_payments_withdrawals_create_create",
+        "description": "Create a new withdrawal request (requires admin approval)",
+        "summary": "Create withdrawal request",
+        "tags": [
+          "payments"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/WithdrawalCreateRequest"
+              }
+            },
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "$ref": "#/components/schemas/WithdrawalCreateRequest"
+              }
+            },
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/WithdrawalCreateRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "security": [
+          {
+            "jwtAuthWithLastLogin": []
+          }
+        ],
+        "responses": {
+          "201": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/WithdrawalCreateResponse"
+                }
+              }
+            },
+            "description": ""
+          },
+          "400": {
+            "description": "Validation error"
+          }
+        },
+        "x-async-capable": false
+      }
     }
   },
   "components": {
@@ -496,31 +782,143 @@
           }
         }
       },
-      "PaymentDetail": {
+      "PaginatedWithdrawalListList": {
         "type": "object",
-        "description": "Detailed payment information.",
+        "required": [
+          "count",
+          "page",
+          "pages",
+          "page_size",
+          "has_next",
+          "has_previous",
+          "results"
+        ],
         "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)"
+          "count": {
+            "type": "integer",
+            "description": "Total number of items across all pages",
+            "example": 150
           },
-          "amount_usd": {
-            "type": "string",
-            "format": "decimal",
-            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
-            "readOnly": true,
-            "description": "Payment amount in USD"
+          "page": {
+            "type": "integer",
+            "description": "Current page number (1-based)",
+            "example": 2
           },
-          "currency_code": {
-            "type": "string",
-            "readOnly": true
+          "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/WithdrawalList"
+            },
+            "description": "Array of items for current page"
+          }
+        }
+      },
+      "PaymentCreateRequest": {
+        "type": "object",
+        "description": "Serializer for creating payment.",
+        "properties": {
+          "amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "description": "Payment amount in USD"
+          },
+          "currency_code": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Currency code (e.g., USDTTRC20)",
+            "maxLength": 20
+          },
+          "description": {
+            "type": "string",
+            "description": "Optional payment description",
+            "maxLength": 500
+          }
+        },
+        "required": [
+          "amount_usd",
+          "currency_code"
+        ]
+      },
+      "PaymentCreateResponse": {
+        "type": "object",
+        "description": "Response for payment creation.",
+        "properties": {
+          "success": {
+            "type": "boolean"
+          },
+          "payment": {
+            "$ref": "#/components/schemas/PaymentDetail"
+          },
+          "qr_code_url": {
+            "type": "string",
+            "format": "uri",
+            "nullable": true
+          }
+        },
+        "required": [
+          "payment",
+          "qr_code_url",
+          "success"
+        ]
+      },
+      "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",
@@ -539,24 +937,21 @@
             "format": "decimal",
             "pattern": "^-?\\d{0,12}(?:\\.\\d{0,8})?$",
             "readOnly": true,
-            "nullable": true,
-            "description": "Amount to pay in cryptocurrency"
+            "nullable": true
           },
           "actual_amount": {
             "type": "string",
             "format": "decimal",
             "pattern": "^-?\\d{0,12}(?:\\.\\d{0,8})?$",
             "readOnly": true,
-            "nullable": true,
-            "description": "Actual amount received in cryptocurrency"
+            "nullable": true
           },
           "actual_amount_usd": {
             "type": "string",
             "format": "decimal",
             "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
             "readOnly": true,
-            "nullable": true,
-            "description": "Actual amount received in USD"
+            "nullable": true
           },
           "status": {
             "enum": [
@@ -581,8 +976,7 @@
           "pay_address": {
             "type": "string",
             "readOnly": true,
-            "nullable": true,
-            "description": "Cryptocurrency payment address"
+            "nullable": true
           },
           "qr_code_url": {
             "type": "string",
@@ -594,14 +988,12 @@
             "type": "string",
             "format": "uri",
             "readOnly": true,
-            "nullable": true,
-            "description": "Payment page URL (if provided by provider)"
+            "nullable": true
           },
           "transaction_hash": {
             "type": "string",
             "readOnly": true,
-            "nullable": true,
-            "description": "Blockchain transaction hash"
+            "nullable": true
           },
           "explorer_link": {
             "type": "string",
@@ -618,15 +1010,13 @@
             "type": "string",
             "format": "date-time",
             "readOnly": true,
-            "nullable": true,
-            "description": "When this payment expires (typically 30 minutes)"
+            "nullable": true
           },
           "completed_at": {
             "type": "string",
             "format": "date-time",
             "readOnly": true,
-            "nullable": true,
-            "description": "When this payment was completed"
+            "nullable": true
           },
           "created_at": {
             "type": "string",
@@ -832,6 +1222,326 @@
           "transaction_type",
           "type_display"
         ]
+      },
+      "WithdrawalCancelResponse": {
+        "type": "object",
+        "description": "Response for withdrawal cancellation.",
+        "properties": {
+          "success": {
+            "type": "boolean"
+          },
+          "withdrawal": {
+            "$ref": "#/components/schemas/WithdrawalDetail"
+          },
+          "message": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "message",
+          "success",
+          "withdrawal"
+        ]
+      },
+      "WithdrawalCreateRequest": {
+        "type": "object",
+        "description": "Serializer for creating withdrawal request.",
+        "properties": {
+          "amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "description": "Withdrawal amount in USD (min $10)"
+          },
+          "currency_code": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Currency code (e.g., USDTTRC20)",
+            "maxLength": 20
+          },
+          "wallet_address": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Destination wallet address",
+            "maxLength": 255
+          }
+        },
+        "required": [
+          "amount_usd",
+          "currency_code",
+          "wallet_address"
+        ]
+      },
+      "WithdrawalCreateResponse": {
+        "type": "object",
+        "description": "Response for withdrawal creation.",
+        "properties": {
+          "success": {
+            "type": "boolean"
+          },
+          "withdrawal": {
+            "$ref": "#/components/schemas/WithdrawalDetail"
+          },
+          "message": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "message",
+          "success",
+          "withdrawal"
+        ]
+      },
+      "WithdrawalDetail": {
+        "type": "object",
+        "description": "Detailed withdrawal information.",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "readOnly": true,
+            "description": "Unique identifier for this record"
+          },
+          "internal_withdrawal_id": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Internal withdrawal identifier (WD_YYYYMMDDHHMMSS_UUID)"
+          },
+          "amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Withdrawal amount in USD (min $10)"
+          },
+          "currency_code": {
+            "type": "string",
+            "readOnly": true
+          },
+          "currency_name": {
+            "type": "string",
+            "readOnly": true
+          },
+          "currency_token": {
+            "type": "string",
+            "readOnly": true
+          },
+          "currency_network": {
+            "type": "string",
+            "readOnly": true
+          },
+          "wallet_address": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Destination wallet address"
+          },
+          "network_fee_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Network transaction fee in USD"
+          },
+          "service_fee_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Service fee in USD"
+          },
+          "total_fee_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Total fee (network + service) in USD"
+          },
+          "final_amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Final amount to receive (amount - total_fee)"
+          },
+          "crypto_amount": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,12}(?:\\.\\d{0,8})?$",
+            "readOnly": true,
+            "nullable": true
+          },
+          "status": {
+            "enum": [
+              "pending",
+              "approved",
+              "processing",
+              "completed",
+              "rejected",
+              "cancelled"
+            ],
+            "type": "string",
+            "x-spec-enum-id": "5a5625f418e926b6",
+            "readOnly": true,
+            "description": "Withdrawal status\n\n* `pending` - Pending\n* `approved` - Approved\n* `processing` - Processing\n* `completed` - Completed\n* `rejected` - Rejected\n* `cancelled` - Cancelled"
+          },
+          "status_display": {
+            "type": "string",
+            "readOnly": true
+          },
+          "transaction_hash": {
+            "type": "string",
+            "readOnly": true,
+            "nullable": true
+          },
+          "explorer_link": {
+            "type": "string",
+            "nullable": true,
+            "description": "Get blockchain explorer link.",
+            "readOnly": true
+          },
+          "admin_notes": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Admin notes (reason for rejection, etc.)"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "description": "When this record was created"
+          },
+          "approved_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true
+          },
+          "completed_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true
+          },
+          "rejected_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true
+          },
+          "cancelled_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "nullable": true
+          }
+        },
+        "required": [
+          "admin_notes",
+          "amount_usd",
+          "approved_at",
+          "cancelled_at",
+          "completed_at",
+          "created_at",
+          "crypto_amount",
+          "currency_code",
+          "currency_name",
+          "currency_network",
+          "currency_token",
+          "explorer_link",
+          "final_amount_usd",
+          "id",
+          "internal_withdrawal_id",
+          "network_fee_usd",
+          "rejected_at",
+          "service_fee_usd",
+          "status",
+          "status_display",
+          "total_fee_usd",
+          "transaction_hash",
+          "wallet_address"
+        ]
+      },
+      "WithdrawalList": {
+        "type": "object",
+        "description": "Withdrawal list item (lighter than detail).",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "readOnly": true,
+            "description": "Unique identifier for this record"
+          },
+          "internal_withdrawal_id": {
+            "type": "string",
+            "readOnly": true,
+            "description": "Internal withdrawal identifier (WD_YYYYMMDDHHMMSS_UUID)"
+          },
+          "amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Withdrawal amount in USD (min $10)"
+          },
+          "final_amount_usd": {
+            "type": "string",
+            "format": "decimal",
+            "pattern": "^-?\\d{0,8}(?:\\.\\d{0,2})?$",
+            "readOnly": true,
+            "description": "Final amount to receive (amount - total_fee)"
+          },
+          "currency_code": {
+            "type": "string",
+            "readOnly": true
+          },
+          "currency_token": {
+            "type": "string",
+            "readOnly": true
+          },
+          "status": {
+            "enum": [
+              "pending",
+              "approved",
+              "processing",
+              "completed",
+              "rejected",
+              "cancelled"
+            ],
+            "type": "string",
+            "x-spec-enum-id": "5a5625f418e926b6",
+            "readOnly": true,
+            "description": "Withdrawal status\n\n* `pending` - Pending\n* `approved` - Approved\n* `processing` - Processing\n* `completed` - Completed\n* `rejected` - Rejected\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 withdrawal was completed"
+          }
+        },
+        "required": [
+          "amount_usd",
+          "completed_at",
+          "created_at",
+          "currency_code",
+          "currency_token",
+          "final_amount_usd",
+          "id",
+          "internal_withdrawal_id",
+          "status",
+          "status_display"
+        ]
       }
     },
     "securitySchemes": {