Replace the account cashout locks
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.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
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.
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.
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.
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.
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.
Optional latitude,longitude in decimal degrees. Out of range or malformed values are dropped. Risk analysis only. Ignored for delegated credentials.
Optional client-generated idempotency token (recommended for safe retries).
Request
true rejects every outgoing payment (423 cashout_locked).
Allowed window for outgoing payments. A window crossing midnight is accepted (start greater than end).
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
Locks stored; the response states what applies now and what waits.
When the loosening takes over (6h after the request).