---
updatedAt: 2025-05-20T20:18:28.000Z
agentTools:
  projectIndex: https://dev.caxton.io/llms.txt
---

# Create a Pot.

This endpoint creates a pot. Pots help to keep funds separate from the Main Balance and are used for a range of applications, like budgeting and/or saving. 
            There are no limits as to how many pots can be created.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "v1",
    "title": "Caxton API",
    "description": "The Caxton API"
  },
  "paths": {
    "/api/account/balances/balance/{ccy}/{potPrefix}": {
      "post": {
        "tags": [
          "Account Balance"
        ],
        "summary": "Create a Pot.",
        "description": "This endpoint creates a pot. Pots help to keep funds separate from the Main Balance and are used for a range of applications, like budgeting and/or saving. \r\n            There are no limits as to how many pots can be created.",
        "operationId": "AccountBalanceApi_CreateCurrencyPot",
        "parameters": [
          {
            "name": "ccy",
            "in": "path",
            "description": "",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "potPrefix",
            "in": "path",
            "description": "",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "UserApiToken",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Account.Request.AccountBalanceApiRequest"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Account.Request.AccountBalanceApiRequest"
              }
            },
            "application/xml": {
              "schema": {
                "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Account.Request.AccountBalanceApiRequest"
              }
            },
            "text/xml": {
              "schema": {
                "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Account.Request.AccountBalanceApiRequest"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Account.Request.AccountBalanceApiRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Base.Model.FirebirdApiResponseModelBase_2_CaxtonFx.FirebirdApi.Models.Account.Response.AccountBalanceApiResponse-CaxtonFx.FirebirdApi.Models.Account.Model.AccountBalanceApiModel_"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Base.Model.FirebirdApiResponseModelBase_2_CaxtonFx.FirebirdApi.Models.Account.Response.AccountBalanceApiResponse-CaxtonFx.FirebirdApi.Models.Account.Model.AccountBalanceApiModel_"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://sandbox.caxton.io"
    }
  ],
  "components": {
    "schemas": {
      "CaxtonFx.FirebirdApi.Base.Model.FirebirdApiResponseModelBase_2_CaxtonFx.FirebirdApi.Models.Account.Response.AccountBalanceApiResponse-CaxtonFx.FirebirdApi.Models.Account.Model.AccountBalanceApiModel_": {
        "type": "object",
        "properties": {
          "LoggedInUserName": {
            "type": "string",
            "readOnly": true
          },
          "MainAccountHolderName": {
            "type": "string",
            "readOnly": true
          },
          "Content": {
            "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Account.Response.AccountBalanceApiResponse"
          },
          "AuthorisedClientModel": {
            "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Base.Model.AuthorisedClientModel"
          },
          "AuthorisedUserModel": {
            "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Base.Model.AuthorisedUserModel"
          },
          "FirebirdApiError": {
            "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Error.FirebirdApiError"
          }
        }
      },
      "CaxtonFx.FirebirdApi.Models.Account.Response.AccountBalanceApiResponse": {
        "type": "object",
        "properties": {
          "Model": {
            "$ref": "#/components/schemas/CaxtonFx.FirebirdApi.Models.Account.Model.AccountBalanceApiModel"
          },
          "ExpectedResponses": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "CaxtonFx.FirebirdApi.Base.Model.AuthorisedClientModel": {
        "description": "Authorised Client",
        "type": "object",
        "properties": {
          "ClientId": {
            "format": "uuid",
            "description": "This is a GUID created at the time of first registration.",
            "type": "string",
            "readOnly": true,
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "ClientRef": {
            "description": "This is a unique string created for the API client at the time of first registration.",
            "type": "string",
            "readOnly": true
          },
          "UserId": {
            "description": "The Client's CXTN platform Id. This is a unique Id created at the time of first registration.",
            "type": "string",
            "readOnly": true
          },
          "TokenStartDate": {
            "format": "date-time",
            "description": "The date from when the token is valid. This is set to 30 days until the TokenEndDate, but also configurable.",
            "type": "string",
            "readOnly": true
          },
          "TokenEndDate": {
            "format": "date-time",
            "description": "The date the token expires. This is set to 30 days from the TokenStartDate, but also configurable.",
            "type": "string",
            "readOnly": true
          }
        }
      },
      "CaxtonFx.FirebirdApi.Base.Model.AuthorisedUserModel": {
        "description": "Authorised User",
        "type": "object",
        "properties": {
          "UserId": {
            "description": "The User's CXTN platform Id. This is a unique Id created at the time of first registration.",
            "type": "string",
            "readOnly": true
          },
          "AppVersion": {
            "description": "",
            "type": "string",
            "readOnly": true
          },
          "TokenStartDate": {
            "format": "date-time",
            "description": "Timestamp assigned when the token becomes valid. This is set to 30 days until the TokenEndDate, but also configurable.",
            "type": "string",
            "readOnly": true
          },
          "TokenEndDate": {
            "format": "date-time",
            "description": "Timestamp assigned when the token expires. This is set to 30 days from the TokenStartDate, but also configurable.",
            "type": "string",
            "readOnly": true
          },
          "LoginTimestamp": {
            "format": "date-time",
            "description": "The timestamp created upon User login. Indicates the time and date the User logged in.",
            "type": "string",
            "readOnly": true
          },
          "ApiLoginType": {
            "description": "Describes the type of user account currently logged in.",
            "enum": [
              "UserApiToken",
              "ClientApiTokenWrapped",
              "UserApiTokenOverridden"
            ],
            "type": "string",
            "readOnly": true
          }
        }
      },
      "CaxtonFx.FirebirdApi.Models.Error.FirebirdApiError": {
        "type": "object",
        "properties": {
          "ExpectedResponses": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "readOnly": true
          },
          "AdditionalInfo": {
            "type": "object"
          },
          "Exception": {
            "type": "object"
          },
          "ApiStatusCode": {
            "type": "string",
            "readOnly": true
          },
          "ApiStatus": {
            "type": "string",
            "readOnly": true
          },
          "ApiStatusDescription": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "CaxtonFx.FirebirdApi.Models.Account.Model.AccountBalanceApiModel": {
        "type": "object",
        "properties": {
          "Balances": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CaxtonFx.Business.API.Entities.Currency.CurrencyBalanceApiEntity"
            },
            "readOnly": true
          },
          "ApiStatusCode": {
            "type": "string",
            "readOnly": true
          },
          "ApiStatus": {
            "type": "string",
            "readOnly": true
          },
          "ApiStatusDescription": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "CaxtonFx.Business.API.Entities.Currency.CurrencyBalanceApiEntity": {
        "description": "Currency Balance",
        "type": "object",
        "properties": {
          "Balance": {
            "format": "double",
            "description": "Describes the amount in the Main Balance or Pot.",
            "type": "number"
          },
          "CcyCode": {
            "description": "For Main Balances, this value consists of a three-letter currency code as per [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). For Pots, this value is the name of the Pot.",
            "type": "string"
          },
          "BaseCcyCode": {
            "description": "A three-letter currency code as per [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).",
            "type": "string"
          },
          "FriendlyName": {
            "description": "Describes a Pot. E.g. Marketing budget, Stationary, Food and drink, etc.",
            "type": "string"
          },
          "AlphabeticCode": {
            "description": "A three-letter currency code as per [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).",
            "type": "string"
          },
          "Description": {
            "description": "Describes the currency. E.g. US Dollar, British Pound Sterling, Euro, etc.",
            "type": "string"
          },
          "NumericCode": {
            "description": "The corresponding currency code for the balance. This is a three-digit numeric code (numeric-3), as per [ISO 3166] (https://www.iso.org/iso-3166-country-codes.html).",
            "type": "string"
          },
          "Symbol": {
            "description": "The corresponding symbol for the currency balance.",
            "type": "string"
          }
        }
      },
      "CaxtonFx.FirebirdApi.Models.Account.Request.AccountBalanceApiRequest": {
        "type": "object",
        "properties": {
          "FriendlyName": {
            "maxLength": 100,
            "minLength": 0,
            "type": "string"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```