Skip to main content
GET
Get withdrawal limits

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Response

Limits retrieved.

currentLimit
number

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

used
number

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.

remaining
number

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

isNightTime
boolean

Whether reduced night limits are active.

fee
number

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.

dayStartHour
integer

Hour when daytime limits begin (BRT).

dayEndHour
integer

Hour when nighttime limits begin (BRT).

minAmount
number

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.

perTransactionLimit
number | null

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.