> This page is for BaaS.

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

# Retrieve a hold

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

Returns one hold of the account.


Reference: https://docs.api.corpx.com/baas/referencia/holds/get-hold

## 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.
- `holdId` (string, required) — Hold identifier.

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.

## Response

### 200

Hold

- `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.

## Errors

### 404 Not Found Error

`hold_not_found` or account not found (`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

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

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

### HoldReleaseFee

Fee split.

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

## Examples

**Response**

```json
{
  "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_getHold_example
import requests

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

headers = {
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>"
}

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

print(response.json())
```

```javascript Holds_getHold_example
const url = 'https://tenant.api.corpx.com/v1/accounts/accountId/holds/hld_01JB8Z6Q4C9K7X2M3N5P';
const options = {
  method: 'GET',
  headers: {'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_getHold_example
package main

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

func main() {

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

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

	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_getHold_example
require 'uri'
require 'net/http'

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

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

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

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

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

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

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

$client = new \GuzzleHttp\Client();

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

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

```csharp Holds_getHold_example
using RestSharp;

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

```swift Holds_getHold_example
import Foundation

let headers = [
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://tenant.api.corpx.com/v1/accounts/accountId/holds/hld_01JB8Z6Q4C9K7X2M3N5P")! 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()
```