GetAllUserWithdrawSettingRestResponseItem

id stringrequired

Withdraw setting id.

state stringrequired

Possible values: [ACTIVE, DEACTIVE]

Withdraw state.

type stringrequired

Possible values: [DAILY, WEEKLY, MONTHLY, BALANCE]

Withdraw type

balance numberrequired

Balance in R$ cents.

should_debit_balance booleannullable

Defines how the balance field is interpreted. When true or omitted: the balance amount is debited. When false: the balance amount is kept in the account and only the surplus is debited.

wallet_owner_branch string

Wallet owner branch.

wallet_owner_account_number string

Wallet owner account number.

day numbernullable

Schedule a day to execute the withdraw. Returns value only for DAILY type

week_day stringnullable

Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

Schedule a day to execute the withdraw. Returns value only for WEEKLY type

time stringnullable

Scheduled time for the automatic daily withdrawal in HH:mm format (UTC-3 timezone).

created_at date-time

Date of created withdraw.