Skip to navigation

Get the account cashout locks

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.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

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

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Response

Current locks, plus any scheduled loosening.
accountIdstring
currentobject
pendingobjectOptional
pendingEffectiveAtdatetimeOptional

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

pendingReasonenumOptional
Allowed values:
updatedAtdatetimeOptional

Errors

404
Not Found Error