Skip to main content

List Withdraw Settings

GET 
/v1/utils/user-withdraw-settings

Retrieve a list of the user's withdraw settings.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

Header Parameters

    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-lang string

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

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

    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.

Responses​

The user withdraw settings returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    User withdraw setting data.

  • Array [
    • id stringrequired
    state stringrequired

    Possible values: [ACTIVE, DEACTIVE]

    Withdraw state.

    type stringrequired

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

    Withdraw type

    balance numberrequired

    Balance in R$ cents.

    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 objectnullable

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

    created_at date-time

    Date of created withdraw.

  • ]
Loading...