> For the complete documentation index, see [llms.txt](https://selenium-4.gitbook.io/nexus-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://selenium-4.gitbook.io/nexus-docs/documentation/term-deposit/operations/main-1.md).

# Retrieve Term Deposit Account Details

## Retrieve Term Deposit Account Details

> Returns the product, entitlement, interest rate and feature details of a term deposit account.

```json
{"openapi":"3.0.3","info":{"title":"NEXUS Banking Services API","version":"1.0.0"},"tags":[{"name":"term-deposit"}],"servers":[{"url":"https://sandbox.nexus.selenium.ao","description":"Sandbox"},{"url":"https://api-mock.selenium.ao","description":"Mock"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer Token (OAuth2 / OIDC or JWT) passed in the `Authorization` header."}},"responses":{"BadRequest":{"description":"The request payload is invalid — inconsistent dates, an amount ≤ 0, an invalid currency, or missing required fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"Unauthorized":{"description":"Missing, expired or invalid Bearer Token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"Forbidden":{"description":"Authenticated, but missing the scope required for this operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"NotFound":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"InternalServerError":{"description":"Unexpected internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"schemas":{"ErrorEnvelope":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}}},"Error":{"type":"object","required":["status","reason","message","path"],"properties":{"status":{"type":"integer","description":"HTTP status code of the error."},"reason":{"type":"string","description":"High-level error category code."},"message":{"type":"string","description":"Human-readable description of the problem."},"path":{"type":"string","description":"HTTP method and endpoint path that originated the error."},"errordetail":{"type":"array","description":"Detailed error list. May be absent for generic errors (e.g. 500).","items":{"$ref":"#/components/schemas/ErrorDetail"}}}},"ErrorDetail":{"type":"object","properties":{"code":{"type":"string","description":"Domain-specific error code."},"reason":{"type":"string","description":"Textual identifier of the specific cause."},"message":{"type":"string","description":"Detailed message, with concrete values where applicable."}}}}},"paths":{"/v1/term-deposits/{termDepositId}/retrieve":{"get":{"summary":"Retrieve Term Deposit Account Details","description":"Returns the product, entitlement, interest rate and feature details of a term deposit account.","tags":["term-deposit"],"operationId":"retrieveTermDepositAccountDetails","parameters":[{"name":"termDepositId","in":"path","required":true,"description":"Identifier of the term deposit account.","schema":{"type":"string"}},{"name":"includeBalancedAccount","in":"query","required":false,"description":"Whether to include settled (`Balanceada`) accounts: `S`/`N`.","schema":{"type":"string","enum":["S","N"]}}],"responses":{"200":{"description":"Term deposit account details.","content":{"application/json":{"schema":{"type":"object","properties":{"productInstanceReference":{"type":"object","properties":{"termDepositAgreementType":{"type":"string","description":"Type of term deposit agreement."},"productAgreementType":{"type":"string","description":"Type of agreed product."},"agreementStatus":{"type":"string","enum":["Active","Matured","Closed","Cancelled"],"description":"Status of the contract: `Active` (Ativo), `Matured` (Vencido), `Closed` (Encerrado), `Cancelled` (Cancelado)."},"agreementDescription":{"type":"string","description":"Description of the contract."}}},"accountNumber":{"type":"object","properties":{"accountIdentificationType":{"type":"string","description":"Type of account identification."},"accountIdentification":{"type":"string","description":"Physical/identifier number of the account."}}},"customerReference":{"type":"object","properties":{"partyReference":{"type":"string","description":"Identifier of the customer (NIF/code)."}}},"bankBranchLocationReference":{"type":"object","properties":{"branchName":{"type":"string","description":"Code or name of the branch."}}},"accountCurrency":{"type":"object","properties":{"accountCurrencyType":{"type":"string","description":"Type of the account's currency."},"currencyCode":{"type":"string","description":"ISO code of the currency."}}},"entitlementOptionDefinition":{"type":"object","properties":{"termDepositAmount":{"type":"object","properties":{"amountValue":{"type":"string","description":"Value of the deposit."},"currencyCode":{"type":"string","description":"Currency of the amount."}}},"termDepositMaturityDate":{"type":"string","description":"Maturity date of the deposit."},"termDepositOpenDate":{"type":"string","description":"Opening date of the deposit."},"termDepositDuration":{"type":"string","description":"Term/duration in days."},"termDepositAccountBalance":{"type":"string","nullable":true,"description":"Current balance of the term deposit account. Present in the source's response example but not in its field table."},"availableBalance":{"type":"string","nullable":true,"description":"Available balance of the term deposit account. Present in the source's response example but not in its field table."},"termDepositAllowedMinimumBalance":{"type":"string","description":"Minimum allowed balance."},"termDepositAllowedMaximumBalance":{"type":"string","description":"Maximum allowed balance."},"interestRate":{"type":"object","properties":{"rate":{"type":"string","description":"Value of the interest rate (%)."},"interestRateAccount":{"type":"string","description":"Account associated for crediting interest."},"interestRateStartDate":{"type":"string","description":"Start date of the rate's validity."},"interestRateEndDate":{"type":"string","description":"End date of the rate's validity."},"periodicity":{"type":"string","description":"Code of the periodicity."},"periodicityDescription":{"type":"string","description":"Description of the periodicity."},"capitalization":{"type":"string","description":"Whether interest capitalization applies."}}},"termDepositFeatures":{"type":"object","properties":{"productCode":{"type":"string","description":"Internal code of the product."},"componentCode":{"type":"string","description":"Code of the component."},"subscriptionChannel":{"type":"string","description":"Subscription channel."},"transferOnMaturity":{"type":"string","enum":["S","N"],"description":"Transfer on maturity (`S`/`N`)."},"allowManualIncrease":{"type":"string","enum":["S","N"],"description":"Whether manual reinforcements are allowed (`S`/`N`)."},"allowsMobilization":{"type":"string","enum":["S","N"],"description":"Whether early mobilization is allowed (`S`/`N`)."},"allowsAccountRenovation":{"type":"string","enum":["S","N"],"description":"Whether automatic renewal is allowed (`S`/`N`)."},"termDepositAccountDebtCaptives":{"type":"string","nullable":true,"description":"Debit captives held against the term deposit account. Present in the source's response example but not in its field table."},"termDepositAccountCreditCaptives":{"type":"string","nullable":true,"description":"Credit captives held against the term deposit account. Present in the source's response example but not in its field table."}}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://selenium-4.gitbook.io/nexus-docs/documentation/term-deposit/operations/main-1.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.