Skip to content

Reference / @getenginex/sdk / WithdrawalLimits

WithdrawalLimits ​

The operator's withdrawal auto-approval policy and the player's usage today (GET /withdrawals/limits). These are not refusal limits: a withdrawal past any of them is still accepted, but waits for manual approval instead of going out automatically. The refusal limits stay in config.limits.minWithdrawal/maxWithdrawal. Amounts in minor units of currency.

Properties ​

autoApproval ​

autoApproval: boolean

false: every withdrawal waits for manual approval, and dailyCount/dailyAmount are null.


currency ​

currency: string

The operator's currency, e.g. BRL.


dailyAmount ​

dailyAmount: WithdrawalAllowance | null

Amount approved automatically per day, in minor units; null without automatic approval.


dailyCount ​

dailyCount: WithdrawalAllowance | null

Withdrawals approved automatically per day; null without automatic approval.


manualReview ​

manualReview: object

Cases that always wait for manual approval, whatever the allowance.

firstWithdrawal ​

firstWithdrawal: boolean

The player's first withdrawal.

newDestination ​

newDestination: boolean

A withdrawal to a destination (PIX key) the player never used.


maxSingleAmount ​

maxSingleAmount: number | null

Largest single amount approved automatically, in minor units; null without a cap (or without automatic approval).


methods ​

methods: Record<string, WithdrawalMethodLimits>

Overrides per withdrawal method, by method code (e.g. pix); {} when the operator has none.


resetsAt ​

resetsAt: string

When today's allowance starts over (the next midnight in timezone), ISO 8601 (UTC).


timezone ​

timezone: string

IANA time zone of the operator, whose midnight closes the day, e.g. America/Sao_Paulo.