Skip to main content
POST
/
0
/
private
/
CreatePrimeSettlementBatch
Create Prime Settlement Batch
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,
  "asset_kind": "currency"
}
'
{
  "result": {
    "batch": {
      "id": "B_Y7T2LPVX",
      "attributes": {
        "status": "unsettled",
        "confirmed": false,
        "created_at": 1700000000000,
        "trade_count": 5,
        "asset_kind": "currency",
        "updated_at": 1700000100000
      },
      "legs": [
        {
          "status": "unsettled",
          "asset": "BTC",
          "amount": "1.5",
          "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

​
asset_kind
enum<string> | null
default:currency

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.

Available options:
currency,
tokenized_equity
Example:

"currency"

Response

Settlement batch created.

Response containing the newly created Prime settlement batch.

​
result
object
required
​
error
string[]
required

Kraken API error