List settlement cycles

GET 
/v1/settlement-cycles

List the settlement cycles of the calling bank as issuer.

A settlement cycle batches the interbank redemptions of one issuer and one root asset (for example Bank Alpha and usd) for periodic cash settlement outside the platform. Cycles are opened, locked, cash-settled, and closed automatically by the platform settlement scheduler; banks cannot create or change them through this API.

Who sees what. Only cycles whose issuer is the calling bank are returned. A holder bank follows its own redemptions through GET /v1/redemptions (each redemption carries its assigned_cycle_id), not through this endpoint.

Lifecycle.

OPEN ──► LOCKED ──► CASH_SETTLED ──► CLOSE_PENDING ──► CLOSED
           │
           ├──► MANUAL_REVIEW ──┐
           │                    ▼
           └──────────────► ABORT_PENDING ──► ABORTED

status	Meaning
OPEN	Accepts new redemptions. cutoff_at is the planned lock time.
LOCKED	The cutoff has passed. No new redemptions are assigned; the assigned redemptions are locked on the ledger and the cycle waits for cash settlement.
CASH_SETTLED	Receipt of the cash has been confirmed (see cash_settlement); the redemptions are about to be burned on the ledger.
CLOSE_PENDING	The ledger redemptions have been submitted and the platform is waiting for ledger finality.
CLOSED	Terminal. All locked redemptions were redeemed (REDEEMED).
MANUAL_REVIEW	Automatic processing stopped (for example a lock could not be placed, or the cash evidence did not match the netting report); the platform operator must repair or abort the cycle.
ABORT_PENDING	Lock releases have been submitted and the platform is waiting for ledger finality.
ABORTED	Terminal. All locks were released and the redemptions are RELEASED. A cycle can be aborted only from LOCKED or MANUAL_REVIEW.

Ordering and paging. Results are ordered by cycle id, descending. Cycle ids are derived deterministically and are not time ordered, so do not rely on the list order for chronology; use filter[cutoff_after] and filter[cutoff_before] to select a time range. Follow links.next until it is absent. links.prev is never returned.

Request

Responses

200

One page of the calling issuer's settlement cycles.

400

The request is malformed: invalid JSON syntax, an invalid path or query parameter, a missing required header such as Idempotency-Key, or a single field that fails its own format rule. Fix the request before retrying; retrying it unchanged fails again.

401

The bearer token is missing, malformed, expired, signed by an unknown key, or was not issued by the platform IAM for the Lyriq Connector. Obtain a new token and retry. See the Authentication section.

403

The token is valid but may not perform this request: it lacks the required scope, has no bank membership, needs an x-dan-bank-id header to choose between several memberships, names a bank in x-dan-bank-id it has no membership for, or the caller's bank is suspended or terminated. A new token with the same configuration fails the same way. See the Authentication section.

429

The request was refused because a rate limit was reached (code RATE_LIMITED). No Retry-After header is sent; retry with exponential backoff.

503

The request could not be served right now. Either the network is not fully operational (OUTBOUND_HALTED or READ_ONLY: mutations are refused while read endpoints keep working; OPERATIONAL_STATE_UNKNOWN: the state could not be determined), or a platform dependency is temporarily unavailable. No Retry-After header is sent; retry later with backoff. When retrying a mutation, reuse the same Idempotency-Key and body.