List exposure limits
GET/v1/exposure-limits
List the exposure limits set by the calling bank as holder.
An exposure limit is a cap a holder bank sets on itself: the maximum amount of one
issuer's asset (for example Bank Alpha's usd) that the holder is willing to hold at
any one time. There is one limit per holder, issuer, and root asset. Only the holder
sets and changes it, through
PUT /v1/exposure-limits/{issuer_bank_id}/{asset_id}.
How it is enforced. When an issuer sends an INTERBANK or BANK_ROUTED transfer
to the holder that would leave the holder with more of that issuer's asset than the
limit allows, the transfer does not succeed. The check runs asynchronously after the
sender's transfer is accepted with 202: the sender's operation ends REJECTED or
FAILED and its result_message contains RECEIVER_EXPOSURE_LIMIT_EXCEEDED. Senders
can check in advance with POST /v1/transfers/preflight. The
exposure limit is only checked on inbound transfers; lowering it below the current
holding does not move or unwind anything already held.
Who sees what. Only the limits the calling bank has set as holder are returned. Issuers do not see the exposure limits their holders set.
Ordering and paging. Ordered by issuer bank id, then 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 holder's exposure 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.