Get available cashout limits

GET

https://client.api.corpx.com/v1/accounts/:accountId/limits/available

GET

/v1/accounts/:accountId/limits/available

curl https://client.api.corpx.com/v1/accounts/accountId/limits/available \
     -H "X-Content-SHA256: X-Content-SHA256" \
     -H "X-Request-Signature: X-Request-Signature" \
     -H "X-Request-Timestamp: X-Request-Timestamp" \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>"

{
  "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6",
  "asOf": "2026-02-20T08:33:39Z",
  "timezone": "America/Sao_Paulo",
  "currency": "BRL",
  "items": [
    {
      "operation": "pix_out",
      "source": "ledger",
      "ceilingSource": "MANUAL",
      "singleTransfer": {
        "limitBrl": 50,
        "usedBrl": 150.75,
        "availableBrl": 150.75,
        "resetsAt": "2026-02-20T08:33:39Z",
        "scope": "account"
      },
      "daytime": {
        "limitBrl": 50,
        "usedBrl": 150.75,
        "availableBrl": 150.75,
        "resetsAt": "2026-02-20T08:33:39Z",
        "scope": "account"
      },
      "nighttime": {
        "limitBrl": 50,
        "usedBrl": 150.75,
        "availableBrl": 150.75,
        "resetsAt": "2026-02-20T08:33:39Z",
        "scope": "account"
      },
      "monthly": {
        "limitBrl": 50,
        "usedBrl": 150.75,
        "availableBrl": 150.75,
        "resetsAt": "2026-02-20T08:33:39Z",
        "scope": "account"
      }
    }
  ]
}

Additive read of local cashout limits (PIX, TED, boleto, internal) in the MT window shape, plus used/remaining. Does not change GET /pix/limits, which stays a partner-only ceiling list.

PIX used comes from the local per-window counter (completed payments and, when the partner refuses with Limite restante: R$ X, an alignment of that window). PIX/TED/boleto/internal are fail-open until a staff ceiling exists. A local PIX ceiling does not replace the partner cap (GET /pix/limits stays MT-only). Internal transfers still consult the legacy MySQL ledger when it has a teto.

Additive read of local cashout limits (PIX, TED, boleto, internal) in the MT window shape, plus used/remaining. Does not change `GET /pix/limits`, which stays a partner-only ceiling list. PIX used comes from the local per-window counter (completed payments and, when the partner refuses with `Limite restante: R$ X`, an alignment of that window). PIX/TED/boleto/internal are fail-open until a staff ceiling exists. A local PIX ceiling does not replace the partner cap (`GET /pix/limits` stays MT-only). Internal transfers still consult the legacy MySQL ledger when it has a teto.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired

Account identifier.

Headers

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.

Query parameters

actingDocumentstringOptional

Operator CPF. When set, available is min(account, operator).

Response

Available limits.

accountIdstringOptional

asOfdatetimeOptional

timezonestringOptional

currencyenumOptional

itemslist of objectsOptional

Errors

404

Not Found Error