Skip to main content
GET
/
v1
/
withdrawals
/
limits
Get withdrawal limits
curl --request GET \
  --url https://api.yuvexpay.com/v1/withdrawals/limits \
  --header 'Authorization: Bearer <token>'
{
  "currentLimit": 5000,
  "used": 1200,
  "remaining": 3800,
  "isNightTime": false,
  "fee": 2.49,
  "dayStartHour": 6,
  "dayEndHour": 22
}

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

Current daily limit in BRL.

​
used
number

Amount already withdrawn today.

​
remaining
number

Remaining withdrawal capacity.

​
isNightTime
boolean

Whether reduced night limits are active.

​
fee
number

Withdrawal fee (flat amount in BRL).

​
dayStartHour
integer

Hour when daytime limits begin (BRT).

​
dayEndHour
integer

Hour when nighttime limits begin (BRT).