Withdrawals

Get withdrawal limits

Retrieve your current withdrawal limits, usage and fee. A reduced "nightly" limit applies outside the dayStartHourdayEndHour window (BRT); isNightTime tells you which one currentLimit currently reflects. Day and night share one used counter for the whole Brazilian calendar day.

get/v1/withdrawals/limits

Response

Limits retrieved.

currentLimitnumber

Daily (or nightly, when isNightTime is true) limit in BRL.

usednumber

Amount already consumed today, in BRL. Counts amount + feeAmount of each withdrawal, and is a single counter for the whole Brazilian calendar day — the nightly limit is compared against a total that already includes daytime volume.

remainingnumber

Remaining capacity for the current window, in BRL. Because the fee counts towards the limit, the largest amount you can request is remaining - fee.

isNightTimeboolean

Whether reduced night limits are active.

feenumber

Withdrawal fee, a flat amount in BRL charged on top of amount. Read it from here rather than hardcoding it: it is configurable per account.

dayStartHourinteger

Hour when daytime limits begin (BRT).

dayEndHourinteger

Hour when nighttime limits begin (BRT).

minAmountnumber

Minimum withdrawal amount in BRL that applies to your account, compared against amount (the net) rather than against amount + fee. Never below the R$ 10.00 platform floor, but it can be higher. Unrelated to the routing provider minimum, which surfaces as WITHDRAWAL_BELOW_PROVIDER_MINIMUM.

perTransactionLimitnumber nullable

Largest single withdrawal your account may request, in BRL, or null when no account-level cap applies. Like the daily limit it is compared against amount + fee, so the largest amount you can request is perTransactionLimit - fee. A second, lower ceiling can apply at the PIX provider that routes the payout; it depends on live routing and is not returned here, but it is still evaluated synchronously and comes back as a 400 WITHDRAWAL_LIMIT_EXCEEDED or 400 WITHDRAWAL_BELOW_PROVIDER_MINIMUM on the create call.

Changes

Changed in 2 of the 13 revisions of this API.3

    • added the optional property minAmount to the response with the 200 status

      response-optional-property-added

    • added the optional property perTransactionLimit to the response with the 200 status

      response-optional-property-added

    This revision also has 24 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog