Skip to main content

CreateUserWithdrawSettingRestResponse

    id stringrequired

    User withdraw settings id.

    state stringrequired

    Possible values: [ACTIVE, DEACTIVE]

    User withdraw settings state.

    type stringrequired

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

    Withdraw settings type.

    balance numberrequired

    Withdraw settings balance.

    total_available_balance boolean

    Total available balance for withdraw (if withdraw settings type is DAILY, WEEKLY or MONTHLY).

    should_debit_balance boolean

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

    day number

    Month day of withdraw (if withdraw settings type is MONTHLY).

    week_day string

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

    Week day of withdraw (if withdraw settings type is WEEKLY).

    time string

    Automatic withdraw time in HH:mm format (timezone UTC-3 - Brasilia).

    wallet_id stringrequired

    User wallet id.

    transaction_type_tag stringrequired

    Transaction type tag.

    pix_key_type stringrequired

    Possible values: [CNPJ, CPF, PHONE, EMAIL, EVP]

    Pix key type.

    pix_key stringrequired

    Pix key.

    pix_key_document string

    Pix key document related (CPF or CNPJ).

    created_at date-timerequired

    Date of created withdraw.