Create Prime Settlement Batch

Creates a new Prime settlement batch from pending unsettled trades. Only one active batch can exist at a time.

API Key Permissions Required: Orders and trades - Create & modify orders

POST /0/private/CreatePrimeSettlementBatch

Create Prime Settlement Batch

cURL

curl --request POST \
  --url https://api.kraken.com/0/private/CreatePrimeSettlementBatch \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "nonce": 123
}'

200

{
  "result": {
    "batch": {
      "id": "B_Y7T2LPVX",
      "attributes": {
        "status": "unsettled",
        "confirmed": false,
        "created_at": 1700000000000,
        "trade_count": 5,
        "updated_at": 1700000100000
      },
      "legs": [
        {
          "status": "unsettled",
          "asset": "BTC",
          "amount": "1.5",
          "direction": "incoming",
          "can_settle": true,
          "settled_at": 123,
          "latest_spot_transfer": {}
        }
      ]
    }
  },
  "error": [
    "EGeneral:Invalid arguments"
  ]
}

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json

nonce · integer<int64> · required

Nonce used in construction of API-Sign header

Response

200

application/json

Settlement batch created.

Response containing the newly created Prime settlement batch.

result · object · required

Show child attributes

error · string[] · required

Kraken API error