Cancel an undispatched bank trade and release exact reservations

POST/ledger/securities/orders/{id}/cancel

Fresh verified non-API-key staff with ledger:securities:write required. Requires a bounded note. Only undispatched work can cancel locally; exact actor/note replay remains retained. Dispatched work requires signed zero-fill rejection/cancellation, with no cash or units, rather than a timeout assumption. All mutations require verified authority even in local mode; customers and API keys are refused. Evidence JSON is strict and bounded at 5 MiB; complete responses are bounded at 16 MiB and never silently truncated.

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

notestringRequired

Returns

200 OK

The Bank Securities Order object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/ledger/securities/orders/{id}/cancel' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "string"
  }'

Response200

{
  "accounting_plans": [
    {
      "correction_reason": "string",
      "created_at": "2026-09-17T14:30:00Z",
      "evidence_sha256": "string",
      "journal": {
        "adjusts_period": "string",
        "effective_date": "2026-09-17",
        "entries": [],
        "kind": "string",
        "protected_command_id": "string",
        "reason": "string",
        "release_hold_id": "hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "require_available": false,
        "reversal_of": "string",
        "source_ref": "string",
        "source_service": "string"
      },
      "journal_key": "string",
      "journal_sha256": "string",
      "supersedes_sha256": "string"
    }
  ],
  "actor": "string",
  "cash_hold_id": "hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "cash_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "cash_posting_date": "2026-09-17",
  "created_at": "2026-09-17T14:30:00Z",
  "custody_account": {
    "actor": "string",
    "content_sha256": "string",
    "created_at": "2026-09-17T14:30:00Z",
    "custody_account": {
      "bank_owned": false,
      "custodian_reference": "string",
      "enabled": false,
      "exclusive_core_instructions": false,
      "external_account_reference": "string",
      "key_id": "string",
      "legal_entity": "string",
      "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "no_third_party_lien": false,
      "observed_at": "2026-09-17T14:30:00Z",
      "onboarding": {
        "data": "string",
        "format": "string",
        "sha256": "string"
      },
      "opening_inventory_empty": false,
      "ownership": {
        "reference": "string",
        "sha256": "string"
      },
      "program_id": "string",
      "program_sha256": "string",
      "signature": "string",
      "valid_until": "2026-09-17T14:30:00Z",
      "version": "string"
    },
    "decision": {
      "actor": "string",
      "at": "2026-09-17T14:30:00Z",
      "content_sha256": "string",
      "decision": "string",
      "note": "string"
    },
    "id": "string",
    "instrument": {
      "currency_code": "USD",
      "cusip": "string",
      "eligibility": {
        "reference": "string",
        "sha256": "string"
      },
      "enabled": false,
      "face_value_amount": 10000,
      "issue_date": "2026-09-17",
      "kind": "string",
      "maturity_date": "2026-09-17",
      "name": "string",
      "price_scale": 0,
      "program_id": "string",
      "terms": {
        "data": "string",
        "format": "string",
        "sha256": "string"
      },
      "unit_basis": "string",
      "unit_increment": 0,
      "unit_scale": 0,
      "zero_coupon": false
    },
    "kind": "string",
    "program": {
      "authority": {
        "reference": "string",
        "sha256": "string"
      },
      "bridge_subject": "string",
      "broker_name": "string",
      "broker_reference": "string",
      "custodian_name": "string",
      "custodian_reference": "string",
      "custody_agreement": {
        "reference": "string",
        "sha256": "string"
      },
      "dealers": [
        {}
      ],
      "enabled": false,
      "evidence_keys": {},
      "legal_entity": "string",
      "master_cash_external_account_reference": "string",
      "master_cash_identity": {
        "reference": "string",
        "sha256": "string"
      },
      "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "max_order_amount": 10000,
      "policy": {
        "accounting_evidence": {},
        "accrual_convention": "string",
        "acquisition_fees": "string",
        "cash_rounding": "string",
        "classification": "string",
        "credit_evidence": {},
        "credit_method": "string",
        "recognition": "string",
        "tax_evidence": {},
        "tax_method": "string"
      },
      "provider": "string",
      "trading_agreement": {
        "reference": "string",
        "sha256": "string"
      },
      "valid_from": "2026-09-17",
      "valid_through": "2026-09-17"
    }
  },
  "decision": {
    "actor": "string",
    "at": "2026-09-17T14:30:00Z",
    "content_sha256": "string",
    "decision": "string",
    "note": "string"
  },
  "exceptions": [
    "string"
  ],
  "execution": {
    "broker_reference": "string",
    "confirmation": {
      "data": "string",
      "format": "string",
      "sha256": "string"
    },
    "counterparty": "string",
    "currency_code": "USD",
    "cusip": "string",
    "custodian_reference": "string",
    "dealer_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "dealer_reference": "string",
    "executed_at": "2026-09-17T14:30:00Z",
    "execution_reference": "string",
    "external_account_reference": "string",
    "fee_amount": 10000,
    "instruction_sha256": "string",
    "key_id": "string",
    "legal_entity": "string",
    "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "net_cash_amount": 10000,
    "observed_at": "2026-09-17T14:30:00Z",
    "order_id": "string",
    "price": 0,
    "principal_amount": 10000,
    "side": "string",
    "signature": "string",
    "status": "string",
    "trade_date": "2026-09-17",
    "units": 0,
    "version": "string"
  },
  "id": "string",
  "instruction": {
    "broker_reference": "string",
    "cash_limit_amount": 10000,
    "currency_code": "USD",
    "cusip": "string",
    "custodian_reference": "string",
    "custody_account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "custody_account_sha256": "string",
    "dealer_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "dealer_reference": "string",
    "external_account_reference": "string",
    "id": "string",
    "instrument_id": "string",
    "instrument_sha256": "string",
    "issued_at": "2026-09-17T14:30:00Z",
    "legal_entity": "string",
    "limit_price": 0,
    "lot_id": "string",
    "lot_revision": 0,
    "master_cash_external_account_reference": "string",
    "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "max_fee_amount": 10000,
    "order_id": "string",
    "program_id": "string",
    "program_sha256": "string",
    "request_sha256": "string",
    "settlement_date": "2026-09-17",
    "sha256": "string",
    "side": "string",
    "trade_date": "2026-09-17",
    "units": 0,
    "version": "string"
  },
  "instrument": {
    "actor": "string",
    "content_sha256": "string",
    "created_at": "2026-09-17T14:30:00Z",
    "custody_account": {
      "bank_owned": false,
      "custodian_reference": "string",
      "enabled": false,
      "exclusive_core_instructions": false,
      "external_account_reference": "string",
      "key_id": "string",
      "legal_entity": "string",
      "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "no_third_party_lien": false,
      "observed_at": "2026-09-17T14:30:00Z",
      "onboarding": {
        "data": "string",
        "format": "string",
        "sha256": "string"
      },
      "opening_inventory_empty": false,
      "ownership": {
        "reference": "string",
        "sha256": "string"
      },
      "program_id": "string",
      "program_sha256": "string",
      "signature": "string",
      "valid_until": "2026-09-17T14:30:00Z",
      "version": "string"
    },
    "decision": {
      "actor": "string",
      "at": "2026-09-17T14:30:00Z",
      "content_sha256": "string",
      "decision": "string",
      "note": "string"
    },
    "id": "string",
    "instrument": {
      "currency_code": "USD",
      "cusip": "string",
      "eligibility": {
        "reference": "string",
        "sha256": "string"
      },
      "enabled": false,
      "face_value_amount": 10000,
      "issue_date": "2026-09-17",
      "kind": "string",
      "maturity_date": "2026-09-17",
      "name": "string",
      "price_scale": 0,
      "program_id": "string",
      "terms": {
        "data": "string",
        "format": "string",
        "sha256": "string"
      },
      "unit_basis": "string",
      "unit_increment": 0,
      "unit_scale": 0,
      "zero_coupon": false
    },
    "kind": "string",
    "program": {
      "authority": {
        "reference": "string",
        "sha256": "string"
      },
      "bridge_subject": "string",
      "broker_name": "string",
      "broker_reference": "string",
      "custodian_name": "string",
      "custodian_reference": "string",
      "custody_agreement": {
        "reference": "string",
        "sha256": "string"
      },
      "dealers": [
        {}
      ],
      "enabled": false,
      "evidence_keys": {},
      "legal_entity": "string",
      "master_cash_external_account_reference": "string",
      "master_cash_identity": {
        "reference": "string",
        "sha256": "string"
      },
      "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "max_order_amount": 10000,
      "policy": {
        "accounting_evidence": {},
        "accrual_convention": "string",
        "acquisition_fees": "string",
        "cash_rounding": "string",
        "classification": "string",
        "credit_evidence": {},
        "credit_method": "string",
        "recognition": "string",
        "tax_evidence": {},
        "tax_method": "string"
      },
      "provider": "string",
      "trading_agreement": {
        "reference": "string",
        "sha256": "string"
      },
      "valid_from": "2026-09-17",
      "valid_through": "2026-09-17"
    }
  },
  "lot_id": "string",
  "lot_revision": 0,
  "program": {
    "actor": "string",
    "content_sha256": "string",
    "created_at": "2026-09-17T14:30:00Z",
    "custody_account": {
      "bank_owned": false,
      "custodian_reference": "string",
      "enabled": false,
      "exclusive_core_instructions": false,
      "external_account_reference": "string",
      "key_id": "string",
      "legal_entity": "string",
      "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "no_third_party_lien": false,
      "observed_at": "2026-09-17T14:30:00Z",
      "onboarding": {
        "data": "string",
        "format": "string",
        "sha256": "string"
      },
      "opening_inventory_empty": false,
      "ownership": {
        "reference": "string",
        "sha256": "string"
      },
      "program_id": "string",
      "program_sha256": "string",
      "signature": "string",
      "valid_until": "2026-09-17T14:30:00Z",
      "version": "string"
    },
    "decision": {
      "actor": "string",
      "at": "2026-09-17T14:30:00Z",
      "content_sha256": "string",
      "decision": "string",
      "note": "string"
    },
    "id": "string",
    "instrument": {
      "currency_code": "USD",
      "cusip": "string",
      "eligibility": {
        "reference": "string",
        "sha256": "string"
      },
      "enabled": false,
      "face_value_amount": 10000,
      "issue_date": "2026-09-17",
      "kind": "string",
      "maturity_date": "2026-09-17",
      "name": "string",
      "price_scale": 0,
      "program_id": "string",
      "terms": {
        "data": "string",
        "format": "string",
        "sha256": "string"
      },
      "unit_basis": "string",
      "unit_increment": 0,
      "unit_scale": 0,
      "zero_coupon": false
    },
    "kind": "string",
    "program": {
      "authority": {
        "reference": "string",
        "sha256": "string"
      },
      "bridge_subject": "string",
      "broker_name": "string",
      "broker_reference": "string",
      "custodian_name": "string",
      "custodian_reference": "string",
      "custody_agreement": {
        "reference": "string",
        "sha256": "string"
      },
      "dealers": [
        {}
      ],
      "enabled": false,
      "evidence_keys": {},
      "legal_entity": "string",
      "master_cash_external_account_reference": "string",
      "master_cash_identity": {
        "reference": "string",
        "sha256": "string"
      },
      "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "max_order_amount": 10000,
      "policy": {
        "accounting_evidence": {},
        "accrual_convention": "string",
        "acquisition_fees": "string",
        "cash_rounding": "string",
        "classification": "string",
        "credit_evidence": {},
        "credit_method": "string",
        "recognition": "string",
        "tax_evidence": {},
        "tax_method": "string"
      },
      "provider": "string",
      "trading_agreement": {
        "reference": "string",
        "sha256": "string"
      },
      "valid_from": "2026-09-17",
      "valid_through": "2026-09-17"
    }
  },
  "request": {
    "cash_limit_amount": 10000,
    "currency_code": "USD",
    "custody_account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "dealer_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "dealer_reference": "string",
    "instrument_id": "string",
    "limit_price": 0,
    "lot_id": "string",
    "max_fee_amount": 10000,
    "program_id": "string",
    "rationale": "string",
    "settlement_date": "2026-09-17",
    "side": "string",
    "trade_date": "2026-09-17",
    "units": 0
  },
  "request_sha256": "string",
  "resolutions": [
    {
      "actor": "string",
      "at": "2026-09-17T14:30:00Z",
      "content_sha256": "string",
      "decision": "string",
      "note": "string"
    }
  ],
  "settlement": {
    "broker_reference": "string",
    "cash_evidence": {
      "data": "string",
      "format": "string",
      "sha256": "string"
    },
    "cash_reference": "string",
    "currency_code": "USD",
    "cusip": "string",
    "custodian_reference": "string",
    "delivery_evidence": {
      "data": "string",
      "format": "string",
      "sha256": "string"
    },
    "delivery_reference": "string",
    "execution_sha256": "string",
    "external_account_reference": "string",
    "fee_amount": 10000,
    "instruction_sha256": "string",
    "key_id": "string",
    "legal_entity": "string",
    "master_cash_external_account_reference": "string",
    "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "master_cash_statement_line_reference": "string",
    "master_cash_statement_reference": "string",
    "net_cash_amount": 10000,
    "observed_at": "2026-09-17T14:30:00Z",
    "order_id": "string",
    "principal_amount": 10000,
    "settled_at": "2026-09-17T14:30:00Z",
    "settlement_date": "2026-09-17",
    "settlement_reference": "string",
    "side": "string",
    "signature": "string",
    "units": 0,
    "version": "string"
  },
  "source": {
    "captured_at": "2026-09-17T14:30:00Z",
    "cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "external_account_reference": "string",
    "legal_entity": "string",
    "master_cash_external_account_reference": "string"
  },
  "status": "string",
  "trade_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "trade_posting_date": "2026-09-17"
}