Get an operation
GET/v1/operations/:operation_id
Fetch one operation by operation_id. This is how you learn the outcome of any
mutation that returned 202 Accepted.
Required scope: connector:operations:read.
Poll until state is terminal (SUCCEEDED, REJECTED, FAILED, CANCELLED or
EXPIRED); see "Asynchronous mutations and operations" in the API overview for a
polling example. On REJECTED, FAILED or EXPIRED, result_code and
result_message explain why. While the operation is
PENDING_REVIEW, it waits for review decisions; while it is MANUAL_REVIEW, an
operator must reconcile it, so do not resubmit the request.
The operation's target resource is linked from relationships.resource. You can read
operations your bank initiated and operations in which your bank is the counterparty;
any other operation_id returns 404 Not Found.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 503
The operation.
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 resource does not exist, or it belongs to another bank. The Lyriq Connector does not distinguish the two cases, so resources of other banks are never disclosed.
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.