Cancel an undispatched bank repo and release only local reservations

POST/bank-repos/{id}/cancel

Fresh verified staff with ledger:repo:write is required. Only an undispatched proposed or approved repo can cancel and release local reservations. Exact cancellation actor and reason are retained for immutable replay. A dispatched borrowing, actual debt or actual custody pledge cannot be canceled into a fictional return of cash or collateral. Every route requires verified non-API-key authority even locally; customer actors are refused. JSON evidence is one strict object bounded at 5 MiB. Complete responses are bounded at 16 MiB and fail explicitly without truncation.

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

reasonstringRequired

Returns

200 OK

The Bank Repo 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/bank-repos/{id}/cancel' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "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"
    }
  ],
  "accrued_to_date": "2026-09-17",
  "actor": "string",
  "admissions": [
    {
      "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "observation": {
        "content_sha256": "string",
        "customer_sha256": "string",
        "observed_at": "2026-09-17T14:30:00Z",
        "record": {}
      }
    }
  ],
  "cancellation": {
    "actor": "string",
    "at": "2026-09-17T14:30:00Z",
    "reason": "string"
  },
  "collateral": [
    {
      "custody_account": {
        "actor": "string",
        "content_sha256": "string",
        "created_at": "2026-09-17T14:30:00Z",
        "custody_account": {},
        "decision": {},
        "id": "string",
        "instrument": {},
        "kind": "string",
        "program": {}
      },
      "lot": {
        "accrued_to_date": "2026-09-17",
        "actual_proceeds_amount": 10000,
        "cash_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "disposal_cash_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "disposal_date": "2026-09-17",
        "disposal_execution_sha256": "string",
        "disposal_order_id": "string",
        "disposal_settlement_date": "2026-09-17",
        "disposal_settlement_sha256": "string",
        "disposal_trade_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "exceptions": [],
        "execution_sha256": "string",
        "external_account_reference": "string",
        "id": "string",
        "instrument": {},
        "latest_observation": {},
        "latest_valuation": {},
        "legal_entity": "string",
        "original_cost_amount": 10000,
        "program": {},
        "purchase_order_id": "string",
        "redemption_id": "string",
        "reservation_revision": 0,
        "reserved_order_id": "string",
        "reserved_redemption_id": "string",
        "revision": 0,
        "schedule": {},
        "settlement_date": "2026-09-17",
        "settlement_sha256": "string",
        "status": "string",
        "trade_date": "2026-09-17",
        "trade_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "units": 0
      },
      "observation": {
        "accrued_income_amount": 10000,
        "as_of": "2026-09-17",
        "close_out_complete": false,
        "currency_code": "USD",
        "cusip": "string",
        "custodian_reference": "string",
        "encumbered_units": 0,
        "evidence": {},
        "external_account_reference": "string",
        "fair_value_amount": 10000,
        "key_id": "string",
        "legal_entity": "string",
        "lot_id": "string",
        "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "observed_at": "2026-09-17T14:30:00Z",
        "original_execution_sha256": "string",
        "original_settlement_sha256": "string",
        "price": 0,
        "price_basis": "string",
        "signature": "string",
        "units": 0,
        "valuation_basis": "string",
        "version": "string"
      }
    }
  ],
  "content_sha256": "string",
  "created_at": "2026-09-17T14:30:00Z",
  "custody_proofs": [
    {
      "evidence": {
        "data": "string",
        "format": "string",
        "sha256": "string"
      },
      "instruction_sha256": "string",
      "key_id": "string",
      "lot_id": "string",
      "observation": {
        "accrued_income_amount": 10000,
        "as_of": "2026-09-17",
        "close_out_complete": false,
        "currency_code": "USD",
        "cusip": "string",
        "custodian_reference": "string",
        "encumbered_units": 0,
        "evidence": {},
        "external_account_reference": "string",
        "fair_value_amount": 10000,
        "key_id": "string",
        "legal_entity": "string",
        "lot_id": "string",
        "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "observed_at": "2026-09-17T14:30:00Z",
        "original_execution_sha256": "string",
        "original_settlement_sha256": "string",
        "price": 0,
        "price_basis": "string",
        "signature": "string",
        "units": 0,
        "valuation_basis": "string",
        "version": "string"
      },
      "observed_at": "2026-09-17T14:30:00Z",
      "original_program_id": "string",
      "original_program_sha256": "string",
      "pledge_reference": "string",
      "signature": "string",
      "state": "string",
      "transaction_id": "string",
      "version": "string"
    }
  ],
  "decision": {
    "actor": "string",
    "at": "2026-09-17T14:30:00Z",
    "content_sha256": "string",
    "decision": "string",
    "note": "string"
  },
  "exceptions": [
    "string"
  ],
  "funding": {
    "cash_evidence": {
      "data": "string",
      "format": "string",
      "sha256": "string"
    },
    "cash_reference": "string",
    "confirmation": {
      "data": "string",
      "format": "string",
      "sha256": "string"
    },
    "currency_code": "USD",
    "fee_amount": 10000,
    "instruction_sha256": "string",
    "interest_amount": 10000,
    "key_id": "string",
    "legal_entity": "string",
    "lender_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "lender_reference": "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",
    "principal_amount": 10000,
    "repayment_instruction_sha256": "string",
    "settled_at": "2026-09-17T14:30:00Z",
    "settlement_date": "2026-09-17",
    "signature": "string",
    "transaction_id": "string",
    "version": "string"
  },
  "funding_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "id": "string",
  "instruction": {
    "collateral": [
      {
        "cusip": "string",
        "custody_account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "custody_account_sha256": "string",
        "external_account_reference": "string",
        "lot_id": "string",
        "lot_revision": 0,
        "observation_sha256": "string",
        "original_program_id": "string",
        "original_program_sha256": "string",
        "original_settlement_sha256": "string",
        "units": 0
      }
    ],
    "content_sha256": "string",
    "currency_code": "USD",
    "decision_sha256": "string",
    "id": "string",
    "issued_at": "2026-09-17T14:30:00Z",
    "legal_entity": "string",
    "lender_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "lender_reference": "string",
    "master_cash_external_account_reference": "string",
    "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "program_id": "string",
    "program_sha256": "string",
    "repurchase_amount": 10000,
    "schedule": {
      "day_count": "string",
      "maturity_date": "2026-09-17",
      "principal_amount": 10000,
      "rate_bps": 0,
      "rounding": "string",
      "start_date": "2026-09-17"
    },
    "sha256": "string",
    "transaction_id": "string",
    "version": "string"
  },
  "program": {
    "actor": "string",
    "content_sha256": "string",
    "created_at": "2026-09-17T14:30:00Z",
    "decision": {
      "actor": "string",
      "at": "2026-09-17T14:30:00Z",
      "content_sha256": "string",
      "decision": "string",
      "note": "string"
    },
    "id": "string",
    "kind": "string",
    "program": {
      "agreement": {
        "data": "string",
        "format": "string",
        "sha256": "string"
      },
      "authority": {
        "reference": "string",
        "sha256": "string"
      },
      "cash_bridge_subject": "string",
      "cash_evidence_keys": {},
      "custodian_reference": "string",
      "custody_bridge_subject": "string",
      "custody_provider": "string",
      "enabled": false,
      "haircut_bps": 0,
      "intermediaries": [
        {}
      ],
      "legal_entity": "string",
      "lender": {
        "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "external_reference": "string",
        "identity": {},
        "legal_name": "string"
      },
      "master_cash_external_account_reference": "string",
      "master_cash_identity": {
        "reference": "string",
        "sha256": "string"
      },
      "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "max_excess_collateral_amount": 10000,
      "max_principal_amount": 10000,
      "max_rate_bps": 0,
      "max_term_days": 0,
      "provider": "string",
      "terms": {
        "accounting": "string",
        "accounting_opinion": {},
        "automatic_renewal": false,
        "bank_entitled_and_obligated": false,
        "concurrent_repurchase_agreement": false,
        "counterparty_may_reuse": false,
        "day_count": "string",
        "default_policy": "string",
        "default_procedures": {},
        "early_termination": false,
        "enforceability_opinion": {},
        "floating_rate": false,
        "margin_policy": "string",
        "margin_procedures": {},
        "rounding": "string",
        "same_securities_return": false,
        "segregated_collateral": false,
        "substitution": false
      },
      "valid_from": "2026-09-17",
      "valid_through": "2026-09-17"
    }
  },
  "repayment": {
    "cash_evidence": {
      "data": "string",
      "format": "string",
      "sha256": "string"
    },
    "cash_reference": "string",
    "confirmation": {
      "data": "string",
      "format": "string",
      "sha256": "string"
    },
    "currency_code": "USD",
    "fee_amount": 10000,
    "instruction_sha256": "string",
    "interest_amount": 10000,
    "key_id": "string",
    "legal_entity": "string",
    "lender_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "lender_reference": "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",
    "principal_amount": 10000,
    "repayment_instruction_sha256": "string",
    "settled_at": "2026-09-17T14:30:00Z",
    "settlement_date": "2026-09-17",
    "signature": "string",
    "transaction_id": "string",
    "version": "string"
  },
  "repayment_hold_id": "hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "repayment_instruction": {
    "cash_amount": 10000,
    "currency_code": "USD",
    "due_date": "2026-09-17",
    "funding_sha256": "string",
    "hold_id": "hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "interest_amount": 10000,
    "issued_at": "2026-09-17T14:30:00Z",
    "legal_entity": "string",
    "lender_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "lender_reference": "string",
    "master_cash_external_account_reference": "string",
    "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "original_instruction_sha256": "string",
    "principal_amount": 10000,
    "sha256": "string",
    "transaction_id": "string",
    "version": "string"
  },
  "repayment_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "request": {
    "currency_code": "USD",
    "lot_ids": [
      "string"
    ],
    "maturity_date": "2026-09-17",
    "principal_amount": 10000,
    "proceeds_beneficiary_customer_ids": [
      "string"
    ],
    "proceeds_use": {
      "reference": "string",
      "sha256": "string"
    },
    "program_id": "string",
    "rate_bps": 0,
    "rationale": "string",
    "start_date": "2026-09-17"
  },
  "request_sha256": "string",
  "status": "string"
}