Kardlane
API Reference

Stop the bot on a trade

POSThttps://api.kardlane.com/v1/trades/{id}/stop

Permanent. The bot will not act on this trade again: it moves to review, you receive one trade.escalated (reason “Bot stopped by …”), and you finish it with Resolve a trade. No workflow messages go to the vendor after a stop.

Authorization#

Authorizationheaderrequired

Bearer token: Bearer <your project API key>. Create keys in the dashboard under your project’s Integration page.

Path parameters#

idstringrequired

The trade.

Body#

bystring

Who is stopping it.

notestring

Why (up to 300 characters) — included in the escalation reason.

Responses#

200Stopped — the trade is waiting for review.
409Already stopped or finished.
curl -X POST https://api.kardlane.com/v1/trades/6abea25d-0c1f-4a43-9d1e-3b5c2f0edad5/stop \
  -H "Authorization: Bearer $KARDLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "by": "ops@yourcompany.com",
    "note": "Handling this one with the vendor directly"
  }'
{
  "tradeId": "6abea25d-0c1f-4a43-9d1e-3b5c2f0edad5",
  "status": "ESCALATED",
  "bot": {
    "state": "stopped",
    "pausedAt": null,
    "pausedBy": null,
    "pauseScope": null,
    "stoppedAt": null,
    "stoppedBy": "ops@yourcompany.com (API)",
    "canPause": false,
    "canResume": false,
    "canStop": false,
    "resumeBlocked": null
  }
}