> This page is for Internet banking (beta).

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://en.docs.api.corpx.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://en.docs.api.corpx.com/_mcp/server.

# List holds

GET https://client.api.corpx.com/v1/accounts/{accountId}/holds

Lists the account's holds, most recent first. Scopes `read`, `holds.read` or `holds.write`.


Reference: https://en.docs.api.corpx.com/ib/referencia/holds/list-holds

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `accountId` (string, required) — Account identifier.

### Query parameters

- `status` (enum, optional) — Filter by status. `held` is not a status: it lists the holds still locking balance at the banking provider (`active`, plus `releasing`/`cancelling` not yet unlocked). Their sum is the `heldAmount` of `GET /balance`.
  - Allowed values: `held`, `active`, `releasing`, `cancelling`, `released`, `cancelled`, `unknown_lock`
- `limit` (integer, optional, default: 100) — Page size (1–200).

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.
- `X-Request-Timestamp` (string, required) — Unix seconds. Required on the signed host; tolerance is 300s either way (`403 request_timestamp_skew`).
- `X-Content-SHA256` (string, required) — Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns `400 body_hash_mismatch`.
- `X-Request-Signature` (string, required) — Detached JWS (`<protected>..<signature>`, ES256 or PS256) over `METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256`.

## Response

### 200

Holds

- `items` (list of Hold, optional)

## Errors

### 400 Bad Request Error

Unknown `status` (`invalid_payload`).

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

### 404 Not Found Error

Account not found for this credential (`not_found`).

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

## Types

### Hold

Part of the account balance locked at the banking provider.

- `holdId` (string, optional) — Hold identifier.
- `accountId` (string, optional) — Account the balance belongs to.
- `status` (enum, optional) — Lifecycle.
  - Allowed values: `active`, `releasing`, `cancelling`, `released`, `cancelled`, `unknown_lock`
- `amount` (string, optional) — Held BRL amount.
- `fee` (string, optional) — Fee withheld on release.
- `reason` (string, optional) — Purpose of the hold.
- `reference` (string, optional) — Your reference.
- `expiresAt` (datetime, optional, nullable) — Automatic cancellation time.
- `release` (HoldRelease, optional) — Destination of the release.
- `transferId` (string, optional) — Internal transfer of the release.
- `feeTransferId` (string, optional) — Internal transfer of the fee.
- `lastError` (string, optional) — Last provider error.
- `releasedAt` (datetime, optional, nullable) — Release time.
- `cancelledAt` (datetime, optional, nullable) — Cancellation time.
- `createdAt` (datetime, optional, nullable) — Creation time.
- `updatedAt` (datetime, optional, nullable) — Last change.
- `source` (HoldSource, optional) — What created the hold. Present only on holds of P2P orders (`reason: p2p_order`); absent on holds created through the API or when the order could not be read. On these holds the destination accounts (`release.toAccountId`, `release.fee.toAccountId`) are omitted and `lastError` is a public code.

### ErrorResponsePartner

Raw error from the settlement bank, when the failure came from it. Diagnostic only.

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional) — Field the partner pointed at, when any.

### HoldRelease

Destination of the release.

- `toAccountId` (string, optional) — Destination account.
- `amount` (string, optional) — Amount sent.
- `fee` (HoldReleaseFee, optional) — Fee split.

### HoldSource

What created the hold. Present only on holds of P2P orders (`reason: p2p_order`); absent on holds created through the API or when the order could not be read. On these holds the destination accounts (`release.toAccountId`, `release.fee.toAccountId`) are omitted and `lastError` is a public code.

- `type` (enum, optional)
  - Allowed values: `p2p_order`
- `orderId` (string, optional)
- `orderStatus` (string, optional) — Current order status.
- `side` (enum, optional) — Side of this account in the order.
  - Allowed values: `buy`, `sell`
- `pair` (string, optional)
- `network` (string, optional)
- `cryptoAmount` (string, optional)
- `price` (string, optional)
- `deadlineAt` (datetime, optional, nullable) — Deadline running now on the order; `null` in dispute or a final status.

### HoldReleaseFee

Fee split.

- `amount` (string, optional) — Fee amount.
- `toAccountId` (string, optional) — Fee account.

## Examples

**Response**

```json
{
  "items": [
    {
      "holdId": "hld_01JB8Z6Q4C9K7X2M3N5P",
      "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6",
      "status": "active",
      "amount": "100.00",
      "fee": "0.00",
      "reason": "escrow",
      "reference": "pedido 42",
      "createdAt": "2026-10-31T14:05:00Z",
      "updatedAt": "2026-10-31T14:05:00Z"
    }
  ]
}
```

**SDK Code**

```python Holds_listHolds_example
import requests

url = "https://client.api.corpx.com/v1/accounts/accountId/holds"

headers = {
    "X-Content-SHA256": "X-Content-SHA256",
    "X-Request-Signature": "X-Request-Signature",
    "X-Request-Timestamp": "X-Request-Timestamp",
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Holds_listHolds_example
const url = 'https://client.api.corpx.com/v1/accounts/accountId/holds';
const options = {
  method: 'GET',
  headers: {
    'X-Content-SHA256': 'X-Content-SHA256',
    'X-Request-Signature': 'X-Request-Signature',
    'X-Request-Timestamp': 'X-Request-Timestamp',
    'X-Tenant-Id': 'X-Tenant-Id',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Holds_listHolds_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://client.api.corpx.com/v1/accounts/accountId/holds"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Content-SHA256", "X-Content-SHA256")
	req.Header.Add("X-Request-Signature", "X-Request-Signature")
	req.Header.Add("X-Request-Timestamp", "X-Request-Timestamp")
	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Holds_listHolds_example
require 'uri'
require 'net/http'

url = URI("https://client.api.corpx.com/v1/accounts/accountId/holds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Content-SHA256"] = 'X-Content-SHA256'
request["X-Request-Signature"] = 'X-Request-Signature'
request["X-Request-Timestamp"] = 'X-Request-Timestamp'
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Holds_listHolds_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://client.api.corpx.com/v1/accounts/accountId/holds")
  .header("X-Content-SHA256", "X-Content-SHA256")
  .header("X-Request-Signature", "X-Request-Signature")
  .header("X-Request-Timestamp", "X-Request-Timestamp")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Holds_listHolds_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://client.api.corpx.com/v1/accounts/accountId/holds', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Content-SHA256' => 'X-Content-SHA256',
    'X-Request-Signature' => 'X-Request-Signature',
    'X-Request-Timestamp' => 'X-Request-Timestamp',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

echo $response->getBody();
```

```csharp Holds_listHolds_example
using RestSharp;

var client = new RestClient("https://client.api.corpx.com/v1/accounts/accountId/holds");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Content-SHA256", "X-Content-SHA256");
request.AddHeader("X-Request-Signature", "X-Request-Signature");
request.AddHeader("X-Request-Timestamp", "X-Request-Timestamp");
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Holds_listHolds_example
import Foundation

let headers = [
  "X-Content-SHA256": "X-Content-SHA256",
  "X-Request-Signature": "X-Request-Signature",
  "X-Request-Timestamp": "X-Request-Timestamp",
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://client.api.corpx.com/v1/accounts/accountId/holds")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```