# Create deposit

Source: https://docs.orbytelabs.com/api-reference/deposits/createDeposit

## POST /v1/deposits

```json
{
  "operationId": "createDeposit",
  "tags": [
    "Deposits"
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "summary": "Create deposit",
  "description": "The idempotency key is unique within the application. Retrying the same deposit returns the existing record without funding the wallet again.",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "identity": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "creditKey": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80,
              "pattern": "^[a-z0-9][a-z0-9_-]*$"
            },
            "amountNanocredits": {
              "type": "string",
              "maxLength": 19,
              "pattern": "^(0|[1-9][0-9]*)$"
            },
            "idempotencyKey": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            }
          },
          "required": [
            "identity",
            "creditKey",
            "amountNanocredits",
            "idempotencyKey"
          ],
          "additionalProperties": false
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Previously accepted deposit",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "deposit": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "identity": {
                    "type": "string"
                  },
                  "creditKey": {
                    "type": "string"
                  },
                  "amountNanocredits": {
                    "type": "string",
                    "maxLength": 19,
                    "pattern": "^(0|[1-9][0-9]*)$"
                  },
                  "idempotencyKey": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "createdAt": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "identity",
                  "creditKey",
                  "amountNanocredits",
                  "idempotencyKey",
                  "createdAt"
                ],
                "additionalProperties": false
              },
              "duplicate": {
                "type": "boolean"
              }
            },
            "required": [
              "deposit",
              "duplicate"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "201": {
      "description": "Deposit created",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "deposit": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "identity": {
                    "type": "string"
                  },
                  "creditKey": {
                    "type": "string"
                  },
                  "amountNanocredits": {
                    "type": "string",
                    "maxLength": 19,
                    "pattern": "^(0|[1-9][0-9]*)$"
                  },
                  "idempotencyKey": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "createdAt": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "identity",
                  "creditKey",
                  "amountNanocredits",
                  "idempotencyKey",
                  "createdAt"
                ],
                "additionalProperties": false
              },
              "duplicate": {
                "type": "boolean"
              }
            },
            "required": [
              "deposit",
              "duplicate"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "401": {
      "description": "Missing, expired, or revoked API key",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "403": {
      "description": "Insufficient permission or unsupported key kind",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "404": {
      "description": "Resource not found",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "409": {
      "description": "Conflict or insufficient balance",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "413": {
      "description": "Body exceeds 16 KiB",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "415": {
      "description": "Content-Type must be application/json",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "422": {
      "description": "Unsupported pricing or billing configuration",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded; see Retry-After",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            },
            "required": [
              "error",
              "message"
            ],
            "additionalProperties": false
          }
        }
      }
    }
  }
}
```

Complete schema: [OpenAPI 3.1 document](https://docs.orbytelabs.com/openapi.json)