> ## Documentation Index > Fetch the complete documentation index at: https://docs.kraken.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Prime Settlement Batch > Creates a new Prime settlement batch from pending unsettled trades. Only one active batch per `asset_kind` can exist at a time. Optionally pass `asset_kind` in the request body to select which trades to include: `currency` (fiat and cryptocurrency positions; default) or `tokenized_equity` (tokenized equity positions). The response includes `trade_ids` — the trade IDs captured in the batch. **API Key Permissions Required:** `Orders and trades - Create & modify orders` ## OpenAPI ````yaml /openapi/prime-rest.yaml post /0/private/CreatePrimeSettlementBatch openapi: 3.0.0 info: title: Prime REST API version: 1.0.0 description: > Kraken Prime REST API — institutional-grade settlement and API-user management. Companion REST surface to the Prime FIX and Prime WebSocket APIs. servers: - url: https://api.kraken.com description: Production Server security: - API-Key: [] API-Sign: [] tags: - name: Settlement - name: API Users - name: API User Keys paths: /0/private/CreatePrimeSettlementBatch: post: tags: - Settlement summary: Create Prime Settlement Batch description: > Creates a new Prime settlement batch from pending unsettled trades. Only one active batch per `asset_kind` can exist at a time. Optionally pass `asset_kind` in the request body to select which trades to include: `currency` (fiat and cryptocurrency positions; default) or `tokenized_equity` (tokenized equity positions). The response includes `trade_ids` — the trade IDs captured in the batch. **API Key Permissions Required:** `Orders and trades - Create & modify orders` operationId: createPrimeSettlementBatch requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePrimeSettlementBatch' responses: '200': description: Settlement batch created. content: application/json: schema: $ref: '#/components/schemas/CreatePrimeSettlementBatch1' '500': $ref: '#/components/responses/500' components: schemas: CreatePrimeSettlementBatch: title: Create Prime Settlement Batch Request Body type: object properties: nonce: $ref: '#/components/schemas/Nonce' asset_kind: type: string nullable: true description: | Kind of assets to include in the settlement batch. - `currency` — Settle fiat and cryptocurrency positions. - `tokenized_equity` — Settle tokenized equity positions. If not specified, defaults to `currency`. enum: - currency - tokenized_equity default: currency example: currency additionalProperties: false required: - nonce CreatePrimeSettlementBatch1: description: Response containing the newly created Prime settlement batch. type: object properties: result: type: object properties: batch: $ref: '#/components/schemas/SettlementBatch' required: - batch additionalProperties: false error: $ref: '#/components/schemas/Error' required: - result - error additionalProperties: false Nonce: description: Nonce used in construction of `API-Sign` header type: integer format: int64 SettlementBatch: description: Prime settlement batch data. type: object properties: id: type: string description: Unique identifier for the settlement batch. example: B_Y7T2LPVX attributes: type: object description: Batch attributes. properties: status: type: string description: > Current status of the batch. - `unsettled` — The batch has no legs settled. - `partially_settled` — The batch has some but not all legs settled. - `settled` — The batch has all legs settled. - `completed` — The batch has been settled and fully processed. enum: - unsettled - partially_settled - settled - completed example: unsettled confirmed: type: boolean description: Whether the batch has been confirmed by Prime's system. example: false created_at: type: integer format: int64 description: Unix timestamp in milliseconds when the batch was created. example: 1700000000000 updated_at: type: integer format: int64 nullable: true description: Unix timestamp in milliseconds when the batch was last updated. example: 1700000100000 trade_count: type: integer format: int64 description: Number of trades in the batch. example: 5 asset_kind: type: string description: | Kind of assets included in the settlement batch. - `currency` — Fiat and cryptocurrency positions. - `tokenized_equity` — Tokenized equity positions. enum: - currency - tokenized_equity example: currency required: - status - confirmed - created_at - trade_count - asset_kind legs: type: array description: Settlement batch legs. items: $ref: '#/components/schemas/BatchLeg' trade_ids: type: array description: >- Trade IDs included in the batch. Returned by Get Prime Settlement Batch and Create Prime Settlement Batch. items: type: string example: - 3f435d6b-62fd-4f26-b1c5-68ef573d93ef - 7f6a6d75-6470-4f65-8b24-9858f28ede83 required: - id - attributes - legs Error: type: array items: description: Kraken API error type: string example: EGeneral:Invalid arguments BatchLeg: description: >- A leg of a Prime settlement batch representing a single asset's net position. type: object properties: status: type: string description: > Current settlement status of the leg. - `unsettled` — No settlement has been initiated for this leg. - `partially_settled` — A settlement transfer has completed but did not cover the full amount. - `in_progress` — A settlement transfer is currently in progress. - `settled` — The leg has been fully settled. enum: - unsettled - partially_settled - in_progress - settled example: unsettled asset: type: string description: Asset being settled. example: BTC amount: type: string description: Net amount of the asset to be settled. example: '1.5' direction: type: string description: | Direction of the settlement from the client's perspective. - `incoming` — The client will receive this asset from Kraken. - `outgoing` — The client owes this asset to Kraken. enum: - incoming - outgoing can_settle: type: boolean description: > Whether this leg is eligible for settlement right now. Returns `false` if a spot transfer is already in progress, the leg is already settled, or the batch is not yet confirmed. For `outgoing` legs (client receives), settlement is handled by Kraken. example: true settled_at: type: integer format: int64 nullable: true description: >- Unix timestamp in milliseconds when the leg was settled. Null if not yet settled. latest_spot_transfer: nullable: true description: The most recent spot transfer associated with this leg, if any. type: object additionalProperties: true required: - status - asset - amount - direction - can_settle responses: '500': description: Internal Server Error content: application/json: schema: type: object properties: error: type: array items: type: string required: - error securitySchemes: API-Key: type: apiKey description: The "API-Key" header should contain your API key. name: API-Key in: header API-Sign: type: apiKey description: >- Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path. name: API-Sign in: header ````