Get a transfer

GET 
/v1/transfers/:transfer_id

Fetch one transfer. Requires scope connector:transfers:read.

The sending bank can read any of its transfers; the receiving bank can read INTERBANK and BANK_ROUTED transfers it receives. The transfer's state mirrors its operation (relationships.operation); fetch the operation for result_code and result_message once the transfer is terminal, and for the review tasks of a transfer in PENDING_REVIEW.

Returns 404 with title transfer not found when the transfer does not exist, is not visible to the calling bank, or has not been recorded yet: a transfer becomes readable shortly after POST /v1/transfers returns 202, so retry a 404 for a just-created transfer after a short delay.

Request

Responses

200

The transfer.

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

The transfer does not exist, is not visible to the calling bank, or has not been recorded yet.

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.