Check withdrawal conditions
View the available balance, fee and limits for requesting a withdrawal.
Check the current account conditions before requesting a withdrawal. The response shows the available balance, minimum amount, fee rule and, in Production, whether a destination is configured and the limits for the period.
This request does not reserve balance or limits. See Withdrawals to interpret these values.
Responses
Response Body
Current withdrawal conditions. In Production, indicates whether a destination is registered and the limits available for retrieval. In the Sandbox, returns the simulated balance, destination_configured false and limits null.
Current conditions for planning a withdrawal. Monetary values use Brazilian real cents. Withdrawal acceptance depends on checking the conditions at the time of the request.
Minimum amount allowed per request, in Brazilian real cents.
Requested amount at or above which the withdrawal fee is zero, in Brazilian real cents.
Fee deducted from the requested amount when it is below fee_threshold_amount_cents, in Brazilian real cents.
Balance available for withdrawal, in Brazilian real cents. The request must also comply with the applicable limits and fee.
Indicates whether the company has its own Pix destination registered for withdrawals. In Sandbox, returns false.
Pix limits and usage for the current period, or null when no limits are available to retrieve. In Sandbox, returns null. This value does not mean that the withdrawal has no limits.
Daily withdrawal limit, in Brazilian real cents. The withdrawal day runs from 06:00 to 06:00 the following day, in São Paulo time.
Nighttime withdrawal limit, in Brazilian real cents, from 20:00 to 06:00 the following day. This amount is part of the daily limit.
Limit applicable to the period indicated by period, in Brazilian real cents.
Amount already committed against the period limit, in Brazilian real cents. Includes withdrawals still being processed.
Amount remaining in the period limit, in Brazilian real cents. It does not represent the account balance.
Reported maximum for a request, in Brazilian real cents, based on withdrawal limits. The available balance and fee also restrict the amount that can be requested.
Current period: day during daytime or night from 20:00 to 06:00, in São Paulo time.
End of the current period, in Unix UTC seconds. Check again after this time for updated conditions.
For common errors, see HTTP response codes.