> 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/current-account/operations/main-2.md).

# Retrieve Blocked Funds (Captives)

## Retrieve Blocked Funds (Captives)

> Returns the blocked funds (captive credit/debit entries) balance and entries for a current account over an optional date range.

```json
{"openapi":"3.0.3","info":{"title":"NEXUS Banking Services API","version":"1.0.0"},"tags":[{"name":"current-account"}],"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":{"CustomerAgreementReference":{"type":"object","description":"Reference to the customer agreement (contract).","properties":{"agreementIdentification":{"type":"object","properties":{"identifierValue":{"type":"object","properties":{"value":{"type":"string","description":"Identifier of the agreement."}}}}},"agreementType":{"type":"string","description":"Type of agreement."}}},"TypedDateTime":{"type":"object","description":"Date/time paired with a timezone and a type/role describing what it represents.","properties":{"dateTimeContent":{"type":"string","format":"date-time","description":"The date/time value."},"timeZoneCode":{"type":"string","description":"Timezone code of the date/time value."},"dateTimeType":{"type":"string","description":"Role of the date/time (e.g. `EffectiveDate`, `ExpiryDate`)."}}},"CaptiveTotal":{"type":"object","description":"Aggregate captive/blocked-funds total (credit, debit, pending or overall).","properties":{"numberOfEntries":{"type":"integer","description":"Number of entries composing the total."},"amount":{"$ref":"#/components/schemas/MonetaryAmountValueWrapped"}}},"MonetaryAmountValueWrapped":{"type":"object","description":"Amount pattern where the numeric value is nested one level deeper, under `amountValue.value`.","properties":{"amountValue":{"type":"object","properties":{"value":{"type":"number","format":"double","description":"Monetary value."}}},"amountCurrency":{"type":"object","properties":{"currencyCode":{"type":"string","description":"ISO 4217 currency code."}}}}},"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/current-accounts/{currentAccountId}/blocked-funds":{"get":{"summary":"Retrieve Blocked Funds (Captives)","description":"Returns the blocked funds (captive credit/debit entries) balance and entries for a current account over an optional date range.","tags":["current-account"],"operationId":"retrieveBlockedFunds","parameters":[{"name":"currentAccountId","in":"path","required":true,"description":"The account number.","schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"description":"Start date of the query range.","schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"description":"End date of the query range.","schema":{"type":"string","format":"date"}},{"name":"status","in":"query","required":false,"description":"Status to filter blocked funds entries by.","schema":{"type":"string"}}],"responses":{"200":{"description":"Blocked funds for the current account.","content":{"application/json":{"schema":{"type":"object","properties":{"currentAccountFulfillmentArrangement":{"type":"object","properties":{"accountIdentification":{"type":"object","description":"Account.","properties":{"accountIdentificationType":{"type":"string","description":"Type of account identification."},"identifierValue":{"type":"object","properties":{"value":{"type":"string","description":"Account number."}}}}},"accountType":{"type":"string","description":"Type of account."},"accountStatus":{"type":"string","description":"Status of the account."},"accountCurrency":{"type":"object","description":"Currency of the account.","properties":{"currencyCode":{"type":"string","description":"ISO 4217 currency code."}}},"customerReference":{"allOf":[{"$ref":"#/components/schemas/CustomerAgreementReference"}],"description":"Customer associated with the account."},"blockedFunds":{"type":"object","description":"Blocked funds (captives) held against the account.","properties":{"dateTimePeriod":{"type":"object","description":"Period covered by the query.","properties":{"fromDateTime":{"allOf":[{"$ref":"#/components/schemas/TypedDateTime"}],"description":"Start date/time of the period."},"toDateTime":{"allOf":[{"$ref":"#/components/schemas/TypedDateTime"}],"description":"End date/time of the period."}}},"blockedFundsBalance":{"type":"object","description":"Totals of blocked funds.","properties":{"totalCreditCaptives":{"allOf":[{"$ref":"#/components/schemas/CaptiveTotal"}],"description":"Total credit captives (cativos)."},"totalDebitCaptives":{"allOf":[{"$ref":"#/components/schemas/CaptiveTotal"}],"description":"Total debit captives (descativos)."},"totalPendingCaptives":{"allOf":[{"$ref":"#/components/schemas/CaptiveTotal"}],"description":"Total pending captives."},"totalBlockedFunds":{"allOf":[{"$ref":"#/components/schemas/CaptiveTotal"}],"description":"Total blocked funds."}}},"blockedFundsEntry":{"type":"array","description":"Movements (entries) of blocked funds.","items":{"type":"object","properties":{"financialAccountingTransactionType":{"type":"string","enum":["Credit","Debit"],"description":"`Credit`=Cativo, `Debit`=Descativo."},"financialAccountingTransactionStatus":{"type":"string","enum":["Posted","Pending"],"description":"`Posted`=Confirmado, `Pending`=Pendente."},"financialAccountingTransactionAmountAndCurrency":{"type":"object","description":"Value of the entry.","properties":{"amount":{"$ref":"#/components/schemas/MonetaryAmountValueWrapped"}}},"valueDate":{"allOf":[{"$ref":"#/components/schemas/TypedDateTime"}],"description":"Value date of the entry."}}}}}}}}}}}}},"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/current-account/operations/main-2.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.