Get a settlement cycle

GET 
/v1/settlement-cycles/:settlement_cycle_id

Fetch a single settlement cycle by settlement_cycle_id.

Only the issuer of the cycle can read it. A cycle that does not exist and one that belongs to another issuer both return 404. A holder bank finds the cycle id of its redemption in assigned_cycle_id on GET /v1/redemptions/{redemption_id}, but cannot read the cycle itself.

The response carries the cycle's status (see GET /v1/settlement-cycles for the lifecycle), cutoff_at, settled_at, closed_at, the cash_settlement evidence once cash has been confirmed, and per-asset asset_summaries while redemptions are assigned or locked.

Request

Responses

200

The requested settlement cycle.

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.

404

No settlement cycle with this id exists for the calling issuer bank.

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.