Skip to main content

Create Withdraw Setting

POST 
/v1/utils/user-withdraw-settings

Create a new withdraw setting for the user.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Body

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

Responses​

User withdraw settings created successfully.

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

Loading...