---
agentTools:
  projectIndex: https://warmkey.readme.io/llms.txt
---

# Create Withdrawal Request

Create withdrawal request.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Endpoints",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.warmkey.finance"
    }
  ],
  "components": {
    "schemas": {
      "header": {
        "type": "object",
        "properties": {
          "api_key": {
            "type": "string"
          },
          "signature": {
            "type": "string"
          },
          "nonce": {
            "type": "string"
          }
        }
      }
    }
  },
  "paths": {
    "/paymentV1/createWithdrawalRequest": {
      "post": {
        "summary": "Create Withdrawal Request",
        "description": "Create withdrawal request.",
        "operationId": "createWithdrawalRequest",
        "tags": [
          ""
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "header": {
                    "$ref": "#/components/schemas/header"
                  },
                  "payload": {
                    "type": "object",
                    "required": [
                      "to",
                      "amount",
                      "network",
                      "unique_id",
                      "coin_symbol"
                    ],
                    "properties": {
                      "to": {
                        "type": "string",
                        "description": "- Format is network's address."
                      },
                      "amount": {
                        "type": "string",
                        "format": "double",
                        "description": "- Format is double."
                      },
                      "network": {
                        "type": "string"
                      },
                      "coin_symbol": {
                        "type": "string"
                      },
                      "unique_id": {
                        "type": "integer",
                        "description": "Can be primary key of withdrawal table. This ensures withdrawal won't pay double."
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "examples": {},
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "example": "100",
                      "description": "Refer to [Response & Errors](api-overview#response--errors)."
                    },
                    "message": {
                      "type": "string",
                      "example": "Success",
                      "description": "Refer to [Response & Errors](api-overview#response--errors)."
                    },
                    "result": {
                      "type": "object",
                      "properties": {
                        "receipt_id": {
                          "type": "integer",
                          "description": "Unique identifier for the withdrawal request that derived by WARMKEY."
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 103,
      "1": 19,
      "2": 54,
      "3": 51,
      "4": 184,
      "5": 127,
      "6": 26,
      "7": 0,
      "8": 111,
      "9": 243,
      "10": 61,
      "11": 118
    }
  }
}
```