> This page is for BaaS.

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

# Replace the account cashout locks

PUT https://tenant.api.corpx.com/v1/accounts/{accountId}/security/locks
Content-Type: application/json

Takes the whole desired document. Applied **field by field**:
tightening (blocking, narrowing the window, removing an IP) takes effect
immediately; loosening waits **6 hours** and comes back as `pending` with
`pendingEffectiveAt`.

Turning `cashoutBlocked` on also pauses the account's active P2P buy ads
(`pausedReason: cashout_locked`); the advertiser reactivates them after
unblocking.

Requires scope `security_locks.manage`.


Reference: https://en.docs.api.corpx.com/baas/referencia/security/set-account-security-locks

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

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.
- `X-Acting-Document` (string, optional) — CPF of the human performing the operation. Required on cashout routes when the credential enforces a transaction PIN. On a company P2P profile contact, this CPF is the holder who signs; it is not taken from the body.
- `X-Acting-Ip` (string, optional) — Real IP of the end user, for integrator credentials calling on their behalf. This is the IP evaluated against `cashoutSourceIps` — without it the check would see your server's IP. Ignored for delegated credentials, where the connection IP is already the right one.
- `X-Acting-User-Agent` (string, optional) — Optional user-agent of the end user's browser or app, for integrator credentials calling on their behalf. Feeds risk analysis only: an invalid or oversized value is dropped and the payment still proceeds. Ignored for delegated credentials.
- `X-Acting-Device-Id` (string, optional) — Optional device fingerprint or identifier from the integrator's own system. Risk analysis only; never required and never a reason to reject the payment. Ignored for delegated credentials.
- `X-Acting-Session-Id` (string, optional) — Optional session id of the end user in the integrator's system. Risk analysis only; never required and never a reason to reject the payment. Ignored for delegated credentials.
- `X-Acting-Geo` (string, optional) — Optional `latitude,longitude` in decimal degrees. Out of range or malformed values are dropped. Risk analysis only. Ignored for delegated credentials.
- `Idempotency-Key` (string, optional) — Optional client-generated idempotency token (recommended for safe retries).

### Body (application/json)

This endpoint expects an AccountSecurityLockDoc.

- `cashoutBlocked` (boolean, optional) — `true` rejects every outgoing payment (`423 cashout_locked`).
- `cashoutHours` (CashoutWindow, optional) — Allowed window for outgoing payments. A window crossing midnight is accepted (`start` greater than `end`).
- `cashoutSourceIps` (list of string, optional) — IPs/CIDRs allowed to move money out. Integrators must pass the end user's IP in `X-Acting-Ip` for this to mean anything.

## Response

### 200

Locks stored; the response states what applies now and what waits.

- `accountId` (string, required)
- `current` (AccountSecurityLockDoc, required)
- `pending` (AccountSecurityLockDoc, optional)
- `pendingEffectiveAt` (datetime, optional) — When the loosening takes over (6h after the request).
- `pendingReason` (enum, optional)
  - Allowed values: `relaxing_security_requires_grace`
- `updatedAt` (datetime, optional)

## Errors

### 404 Not Found Error

Requested resource was 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.

### 422 Unprocessable Entity Error

`invalid_cashout_hours` or `invalid_ip`.

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

### CashoutWindow

Allowed window for outgoing payments. A window crossing midnight is accepted (`start` greater than `end`).

- `start` (string, required)
- `end` (string, required)
- `timezone` (string, optional, default: America/Sao_Paulo)

### AccountSecurityLockDoc

- `cashoutBlocked` (boolean, optional) — `true` rejects every outgoing payment (`423 cashout_locked`).
- `cashoutHours` (CashoutWindow, optional) — Allowed window for outgoing payments. A window crossing midnight is accepted (`start` greater than `end`).
- `cashoutSourceIps` (list of string, optional) — IPs/CIDRs allowed to move money out. Integrators must pass the end user's IP in `X-Acting-Ip` for this to mean anything.

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

## Examples

**Request**

```json
{
  "cashoutBlocked": false,
  "cashoutHours": {
    "start": "08:00",
    "end": "18:00",
    "timezone": "America/Sao_Paulo"
  },
  "cashoutSourceIps": [
    "203.0.113.10/32"
  ]
}
```

**Response**

```json
{
  "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6",
  "current": {
    "cashoutBlocked": false,
    "cashoutHours": {
      "start": "08:00",
      "end": "18:00",
      "timezone": "America/Sao_Paulo"
    },
    "cashoutSourceIps": [
      "203.0.113.10/32"
    ]
  },
  "pending": {
    "cashoutBlocked": false,
    "cashoutHours": {
      "start": "08:00",
      "end": "18:00",
      "timezone": "America/Sao_Paulo"
    },
    "cashoutSourceIps": [
      "203.0.113.10/32"
    ]
  },
  "pendingEffectiveAt": "2026-02-20T08:33:39Z",
  "pendingReason": "relaxing_security_requires_grace",
  "updatedAt": "2026-02-20T08:33:39Z"
}
```

**SDK Code**

```python Security_setAccountSecurityLocks_example
import requests

url = "https://tenant.api.corpx.com/v1/accounts/accountId/security/locks"

payload = {
    "cashoutBlocked": False,
    "cashoutHours": {
        "start": "08:00",
        "end": "18:00",
        "timezone": "America/Sao_Paulo"
    },
    "cashoutSourceIps": ["203.0.113.10/32"]
}
headers = {
    "X-Acting-Geo": "-22.9068,-43.1729",
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript Security_setAccountSecurityLocks_example
const url = 'https://tenant.api.corpx.com/v1/accounts/accountId/security/locks';
const options = {
  method: 'PUT',
  headers: {
    'X-Acting-Geo': '-22.9068,-43.1729',
    'X-Tenant-Id': 'X-Tenant-Id',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"cashoutBlocked":false,"cashoutHours":{"start":"08:00","end":"18:00","timezone":"America/Sao_Paulo"},"cashoutSourceIps":["203.0.113.10/32"]}'
};

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

```go Security_setAccountSecurityLocks_example
package main

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

func main() {

	url := "https://tenant.api.corpx.com/v1/accounts/accountId/security/locks"

	payload := strings.NewReader("{\n  \"cashoutBlocked\": false,\n  \"cashoutHours\": {\n    \"start\": \"08:00\",\n    \"end\": \"18:00\",\n    \"timezone\": \"America/Sao_Paulo\"\n  },\n  \"cashoutSourceIps\": [\n    \"203.0.113.10/32\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Acting-Geo", "-22.9068,-43.1729")
	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

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

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

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

request = Net::HTTP::Put.new(url)
request["X-Acting-Geo"] = '-22.9068,-43.1729'
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cashoutBlocked\": false,\n  \"cashoutHours\": {\n    \"start\": \"08:00\",\n    \"end\": \"18:00\",\n    \"timezone\": \"America/Sao_Paulo\"\n  },\n  \"cashoutSourceIps\": [\n    \"203.0.113.10/32\"\n  ]\n}"

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

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

HttpResponse<String> response = Unirest.put("https://tenant.api.corpx.com/v1/accounts/accountId/security/locks")
  .header("X-Acting-Geo", "-22.9068,-43.1729")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cashoutBlocked\": false,\n  \"cashoutHours\": {\n    \"start\": \"08:00\",\n    \"end\": \"18:00\",\n    \"timezone\": \"America/Sao_Paulo\"\n  },\n  \"cashoutSourceIps\": [\n    \"203.0.113.10/32\"\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://tenant.api.corpx.com/v1/accounts/accountId/security/locks', [
  'body' => '{
  "cashoutBlocked": false,
  "cashoutHours": {
    "start": "08:00",
    "end": "18:00",
    "timezone": "America/Sao_Paulo"
  },
  "cashoutSourceIps": [
    "203.0.113.10/32"
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'X-Acting-Geo' => '-22.9068,-43.1729',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

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

```csharp Security_setAccountSecurityLocks_example
using RestSharp;

var client = new RestClient("https://tenant.api.corpx.com/v1/accounts/accountId/security/locks");
var request = new RestRequest(Method.PUT);
request.AddHeader("X-Acting-Geo", "-22.9068,-43.1729");
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"cashoutBlocked\": false,\n  \"cashoutHours\": {\n    \"start\": \"08:00\",\n    \"end\": \"18:00\",\n    \"timezone\": \"America/Sao_Paulo\"\n  },\n  \"cashoutSourceIps\": [\n    \"203.0.113.10/32\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Security_setAccountSecurityLocks_example
import Foundation

let headers = [
  "X-Acting-Geo": "-22.9068,-43.1729",
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "cashoutBlocked": false,
  "cashoutHours": [
    "start": "08:00",
    "end": "18:00",
    "timezone": "America/Sao_Paulo"
  ],
  "cashoutSourceIps": ["203.0.113.10/32"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://tenant.api.corpx.com/v1/accounts/accountId/security/locks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```