Settle Prime Settlement Batch Asset

Initiates settlement of a specific asset leg within a Prime settlement batch. The batch must be confirmed and the leg must be eligible for settlement (check can_settle on the leg).

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

POST /0/private/SettlePrimeSettlementBatchAsset

Settle Prime Settlement Batch Asset

cURL

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

200

{
  "result": {
    "transfer": {
      "id": "100",
      "attributes": {
        "transfer_status": "pending",
        "transfer_amount": "1.5",
        "transfer_asset": "BTC"
      },
      "relationships": {
        "leg": {
          "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

batch_id · string · required

The unique identifier of the settlement batch.

Example:

"B_Y7T2LPVX"

asset · string · required

The asset to settle within the batch.

Example:

"BTC"

Response

200

application/json

Asset settlement initiated.

Response containing the transfer details for the settled asset.

result · object · required

Show child attributes

error · string[] · required

Kraken API error