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

# Top-up Term Deposit

## Top-up Term Deposit

> Reinforces (tops up) a term deposit with an additional deposit, debiting a source 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."}},"schemas":{"MonetaryAmount":{"type":"object","description":"Generic monetary amount and currency pair.","properties":{"amountValue":{"type":"number","format":"double","description":"Monetary value."},"amountCurrency":{"type":"object","properties":{"currencyCode":{"type":"string","description":"ISO 4217 currency code."}}}}},"TypedDate":{"type":"object","description":"Date paired with a type/role describing what it represents.","properties":{"dateContent":{"type":"string","format":"date","description":"The date value."},"dateType":{"type":"string","description":"Role of the date (e.g. `MaturityDate`, `RepaymentStartDate`)."}}},"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"}}}},"Conflict":{"description":"The resource already exists, or is in a terminal/incompatible state for this operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"UnprocessableEntity":{"description":"A business rule was violated (e.g. insufficient balance, currency mismatch, amount exceeds the outstanding balance).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"InternalServerError":{"description":"Unexpected internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"BadGateway":{"description":"The core banking system is unavailable or returned an invalid response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"GatewayTimeout":{"description":"The call to the core banking system timed out.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"paths":{"/v1/term-deposits/{termDepositId}/deposit/update":{"put":{"summary":"Top-up Term Deposit","description":"Reinforces (tops up) a term deposit with an additional deposit, debiting a source account.","tags":["term-deposit"],"operationId":"topUpTermDeposit","parameters":[{"name":"termDepositId","in":"path","required":true,"description":"Unique identifier of the term deposit contract.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["depositTransactionAmount","depositTransactionDepositType","depositTransaction"],"properties":{"depositTransactionAmount":{"allOf":[{"$ref":"#/components/schemas/MonetaryAmount"},{"type":"object","properties":{"amountType":{"type":"string","default":"Principal","description":"Type of amount."}}}],"description":"Amount to reinforce the term deposit with."},"depositTransactionDepositType":{"type":"string","default":"AdditionalDeposit","description":"Type of deposit."},"depositTransaction":{"type":"object","properties":{"financialTransactionFromAccount":{"type":"object","description":"Source account of the debit.","properties":{"accountIdentification":{"type":"object","properties":{"identifierValue":{"type":"string","description":"Number of the source account (DO)."}}}}}}}}}}}},"responses":{"200":{"description":"Top-up processed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"correlationId":{"type":"string","format":"uuid","description":"Unique correlation identifier of the processed transaction."},"depositTransactionAmount":{"allOf":[{"$ref":"#/components/schemas/MonetaryAmount"}],"description":"Amount reinforced."},"depositTransaction":{"type":"object","properties":{"transactionDate":{"type":"object","properties":{"transactionDate":{"allOf":[{"$ref":"#/components/schemas/TypedDate"}],"description":"Date the transaction was executed."},"transactionDateType":{"type":"string","description":"Type of the transaction date."}}},"financialTransactionFromAccount":{"type":"object","description":"Source account that was debited.","properties":{"accountIdentification":{"type":"object","properties":{"identifierValue":{"type":"string","description":"Number of the debited source account."}}}}},"financialTransactionTargetAccount":{"type":"object","description":"Term deposit account that was credited.","properties":{"accountIdentification":{"type":"object","properties":{"identifierValue":{"type":"string","description":"Number of the credited term deposit account."}}}}}}}}}}}},"202":{"description":"Request accepted; asynchronous execution pending."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"$ref":"#/components/responses/BadGateway"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
```


---

# 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-3.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.