Get an account

DORIC Banking API · Accounts

Preview

Get an account

Returns one account by its stable identifier.

GET/accounts/{accountId}

Authorization

OAuth scope: accounts.readThe access token must carry this scope.
Action: getAccount

Headers

AuthorizationstringRequired
OAuth 2.0 client-credentials flow for machine workloads.
X-Request-IduuidOptional
UUID unique to this HTTP request. The gateway echoes a valid caller-supplied value or generates one when the header is omitted. The resulting value is returned in X-Request-Id and structured error responses.

Path and query parameters

accountIduuidRequired
UUID of the account to retrieve.

Request body

This endpoint takes no request body.

Response

Status 200. Account returned successfully.

balanceMinorintegerRequired
Available balance expressed as an integer in the currency's minor unit.
currencystringRequired
Three-letter ISO 4217 settlement currency code.
pattern ^[A-Z]{3}$
iduuidRequired
Stable account identifier.
ownerIdstringRequired
Customer or legal-entity identifier that owns the account.
minimum length 1
statusenumRequired
Current account lifecycle state.
Allowed values
- pending
- active
- frozen
- closed

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400INVALID_ARGUMENTThe request is malformed.
401UNAUTHENTICATEDAuthentication failed.
403PERMISSION_DENIEDThe principal is not authorized for this operation.
404NOT_FOUNDThe requested resource does not exist.
429RESOURCE_EXHAUSTEDA rate or concurrency limit was exceeded.
503UNAVAILABLEThe service is temporarily unavailable.