Get the account cashout locks

GET

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

GET

/v1/accounts/:accountId/security/locks

curl https://tenant.api.corpx.com/v1/accounts/accountId/security/locks \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>"

{
  "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"
}

Returns the cashout locks currently active on the account and any pending lock change awaiting approval.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired

Account identifier.

Response

Current locks, plus any scheduled loosening.

accountIdstring

currentobject

pendingobjectOptional

pendingEffectiveAtdatetimeOptional

When the loosening takes over (6h after the request).

pendingReasonenumOptional

updatedAtdatetimeOptional

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors