> 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.md).

# Retrieve Term Deposit Accounts

## Retrieve Term Deposit Accounts

> Returns a paginated collection of a customer's term deposit accounts (facilities).

```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."}},"schemas":{"OffsetPagination":{"type":"object","description":"Offset-based pagination metadata.","properties":{"pageNumber":{"type":"integer","description":"Current page number."},"pageSize":{"type":"integer","description":"Number of elements per page."},"totalRecords":{"type":"integer","description":"Total number of records."},"totalPages":{"type":"integer","description":"Total number of pages."}}},"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."}}}},"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"}}}}}},"paths":{"/v1/term-deposits/retrieve-collection":{"get":{"summary":"Retrieve Term Deposit Accounts","description":"Returns a paginated collection of a customer's term deposit accounts (facilities).","tags":["term-deposit"],"operationId":"retrieveTermDepositAccounts","parameters":[{"name":"customerReference","in":"query","required":false,"description":"Identifier of the customer.","schema":{"type":"string"}},{"name":"accountReference","in":"query","required":false,"description":"Associated account.","schema":{"type":"string"}},{"name":"includeSettledAccounts","in":"query","required":false,"description":"Whether to include settled accounts.","schema":{"type":"boolean"}},{"name":"status","in":"query","required":false,"description":"Status to filter by.","schema":{"type":"string","enum":["Active","Matured","Closed"]}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer"}},{"name":"pageSize","in":"query","required":false,"description":"Page size.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Term deposit accounts.","content":{"application/json":{"schema":{"type":"object","properties":{"termDepositFulfillmentArrangements":{"type":"array","description":"List of term deposits.","items":{"type":"object","properties":{"termDepositFulfillmentArrangement":{"type":"object","properties":{"termDepositId":{"type":"string","description":"Identifier of the term deposit."},"customerReference":{"type":"string","description":"Identifier of the customer."},"accountReference":{"type":"string","description":"Associated account."},"termDepositType":{"type":"string","description":"Type of term deposit."},"termDepositStatus":{"type":"string","enum":["Active","Matured","Closed","Cancelled"],"description":"Status of the term deposit: `Active` (Ativo), `Matured` (Vencido), `Closed` (Encerrado), `Cancelled` (Cancelado)."},"termDepositStartDate":{"type":"string","format":"date","description":"Start date of the term deposit."},"termDepositMaturityDate":{"type":"string","format":"date","description":"Maturity date of the term deposit."},"termDepositAmount":{"type":"object","properties":{"amount":{"type":"string","description":"Principal amount."},"currency":{"type":"string","description":"ISO 4217 currency code."}}},"termDepositInterestRate":{"type":"string","description":"Interest rate of the term deposit."},"termDepositInterestRateType":{"type":"string","description":"Type of interest rate."},"termDepositDurationInDays":{"type":"integer","description":"Duration in days."},"termDepositRolloverInstruction":{"type":"string","description":"Instruction to apply at maturity."},"termDepositDisbursementAccount":{"type":"string","description":"Account to which proceeds are disbursed."},"termDepositProductReference":{"type":"string","description":"Reference of the term deposit product."}}}}}},"pagination":{"allOf":[{"$ref":"#/components/schemas/OffsetPagination"}],"description":"Pagination information."}}}}}},"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.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.