Skip to navigation

Request a limit increase

Opens a cashout ceiling increase for one or more operations in the same window and with the same requested amount. Send either operation (legacy single-operation form) or operations (1–4 unique operations), never both. The response groups the operation rows under bundle; documents, messages, submission, cancellation and the review decision apply to the whole bundle. The request is stored as awaiting_documents and stays out of the review queue until POST .../submit. Every catalog document is optional: submit does not require a file. It does not change the ceiling. CorpX reviews it after submit and, on approval, applies the ceiling immediately. effectiveAt stays null until a waiting period exists. Without submit within 7 days the request is cancelled.

identifier must equal the Idempotency-Key header. The same key returns the original request with 201, even if the body differs. A second pending request for the same operation and window, with a different key, is 409 limit_request_pending.

requestedLimitBrl must be strictly above the effective ceiling (422 limit_request_not_above_current). currentLimitBrl is that ceiling, including a previous-register (legacy) ceiling. It is 0 only when the window is open. Approval applies immediately and may be lower than the request, never higher. On a legacy account the other windows of the operation become own ceilings at their current amounts, on ledger hours. risk is stored and shown to the reviewer. risk.action: deny does not reject the request.

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.
Idempotency-KeystringRequired>=8 characters

Client-generated idempotency token.

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.

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.

Request

This endpoint expects any.
anyRequired
OR
anyRequired

Response

Request stored, or the original request for this Idempotency-Key.

idstring
statusenum

awaiting_documents is outside the queue until submit. info_requested means the reviewer asked for more and the 7-day window restarted.

operationenum
Allowed values:
windowenum
Allowed values:
currentLimitBrldouble

Effective ceiling when the request was opened, including a previous-register (legacy) ceiling. 0 only when that window was open (no ceiling).

requestedLimitBrldouble
justificationstring
identifierstring
createdAtdatetime
approvedLimitBrldouble or nullOptional

Ceiling actually applied. Null until approval. May differ from requestedLimitBrl when the reviewer adjusts it.

decisionMessagestring or nullOptional
effectiveAtdatetime or nullOptional
When the new ceiling starts. Null means it was applied immediately.
documentsDueAtdatetime or nullOptional
Deadline to submit documents or the reply to an information request. Null on requests opened before this field existed.
submittedAtdatetime or nullOptional
When the holder submitted the request into the review queue.
bundleobjectOptional
Operations opened together. The bundle ID is the first request ID.
skippedlist of objectsOptional
Operations not opened in this bundle.

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error