Skip to main content

CreateUserWithdrawSettingBody

    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).

    type stringrequired

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

    Withdraw settings type.

    data object required

    Withdraw configuration data (based on type)

    oneOf
    balance number

    Withdraw settings balance in cents, minimum 100.

    total_available_balance boolean

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

    should_debit_balance boolean

    Default value: true

    Defines how the balance field is interpreted for scheduled withdrawals (DAILY, WEEKLY, MONTHLY). When true or omitted (default): the value of balance is debited from the account. When false: the value of balance is kept in the account and only the surplus is debited.

    time string

    Scheduled time for the automatic daily withdrawal in HH:mm format (UTC-3 timezone). If not provided, the withdrawal will run at the default daily schedule.