List redemption policies
GET/v1/redemption-policies
List the redemption policies of the calling bank as holder.
A redemption policy makes the platform create settlement-cycle redemptions
automatically for one interbank holding: the holder's holding of one issuer's asset.
Each policy has exactly one trigger:
trigger.type | What it does |
|---|---|
above_threshold | Whenever the available balance of the holding is greater than threshold, redeem either the excess down to min_balance (redemption_type: excess) or the whole available balance (redemption_type: full). |
scheduled | Starting at start_at and then every repeat_after, redeem either fixed_amount (redemption_strategy: fixed) or the whole available balance (redemption_strategy: full). |
Each run creates a normal redemption (see GET /v1/redemptions) that is settled through
the issuer's next settlement cycle. Amounts are integer strings in the asset's minor
units.
Policy status. ACTIVE policies run. A policy whose automated run fails (for
example because the holding account cannot be resolved) is moved to SUSPENDED and
stops running. A policy can also be REJECTED.
Who sees what. Only policies whose holder_bank_id is the calling bank are returned.
Ordering and paging. Newest first. links.next is present whenever the page is not
empty, even on the last page; keep following it until a page returns an empty data
array. links.prev is never returned.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 503
One page of the calling holder's redemption policies, newest first.
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.