Skip to navigation
API Internet BankingAccounts

Request a limit increase

Opens a cashout ceiling increase for one operation and window. The request is stored as pending_review. It does not change the ceiling. CorpX reviews it and, on approval, applies the ceiling immediately. effectiveAt stays null until a waiting period exists.

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). No ceiling means the current limit is 0. 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.
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-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 an object.
operationenumRequired
Allowed values:
windowenumRequired

Public window name on this route. single_transfer is one payment, daytime is 06:00–20:00, nighttime is 20:00–06:00 (America/Sao_Paulo) and monthly is the calendar month. GET /limits/available uses camelCase for the same windows: singleTransfer here is single_transfer.

Allowed values:
requestedLimitBrldoubleRequired
Ceiling asked for, in BRL. Must be above the current effective ceiling.
justificationstringRequired<=500 characters
identifierstringRequired

Must be identical to the Idempotency-Key header.

riskobject or nullOptional
Risk evaluation produced by the integrator. Stored and shown to the reviewer. A deny does not reject the request.

Response

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

idstring
statusenum
Allowed values:
operationenum
Allowed values:
windowenum
Allowed values:
currentLimitBrldouble
Effective ceiling when the request was opened. 0 when the account had none.
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.

Errors

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