List mint limits
GET/v1/mint-limits
List the mint limits of the calling bank as issuer.
A mint limit caps how much of its own asset an issuer may have issued to other banks
at any one time. There is one limit per issuer and root asset (for example Bank Alpha
and usd), expressed as a single static amount: there is no time window and no
automatic reset. The limit changes only through
PUT /v1/mint-limits/{asset_id} (or when the platform
operator sets it).
How it is enforced. When the issuer sends an INTERBANK or BANK_ROUTED transfer
that must be funded by issuing new units of its own asset, the platform checks the
remaining headroom: the limit minus the issuer's issued balance and any amounts already
reserved for transfers in flight. The check runs asynchronously, after the transfer is
accepted with 202: a transfer that would exceed the limit does not succeed (its
operation ends REJECTED or FAILED) and the operation's result_message contains
MINT_LIMIT_EXCEEDED. To check in advance, call POST /v1/transfers/preflight, which
reports blocking_constraint: MINT_LIMIT_EXCEEDED together with the available headroom.
Who sees what. Only the calling bank's own limits are returned; another issuer's mint limits are never visible.
Ordering and paging. Ordered by root asset id, ascending. Follow links.next until
it is absent. links.prev is never returned.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 503
One page of the calling issuer's mint limits.
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.
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.
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.
The request was refused because a rate limit was reached (code RATE_LIMITED). No
Retry-After header is sent; retry with exponential backoff.
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.