Skip to navigation

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

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-Acting-DocumentstringOptional

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

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-AgentstringOptional<=512 characters

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-IdstringOptional<=128 characters

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-IdstringOptional<=128 characters

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

Optional latitude,longitude in decimal degrees. Out of range or malformed values are dropped. Risk analysis only. Ignored for delegated credentials.

Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Request

This endpoint expects an object.
cashoutBlockedbooleanOptional

true rejects every outgoing payment (423 cashout_locked).

cashoutHoursobjectOptional

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

cashoutSourceIpslist of stringsOptional

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.

accountIdstring
currentobject
pendingobjectOptional
pendingEffectiveAtdatetimeOptional

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

pendingReasonenumOptional
Allowed values:
updatedAtdatetimeOptional

Errors

404
Not Found Error
422
Unprocessable Entity Error