Skip to main content

Create Withdraw Setting Request

POST 

/withdraw-setting-request

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Initiate a request to 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 requisition. All requisitions must have an identifier.

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.

    balance numberrequired

    Withdraw settings balance.

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

Responses

User withdraw settings request created successfully.

Schema
    id stringrequired

    User withdraw settings request id.

    state stringrequired

    Possible values: [PENDING, OPEN, CLOSED, FAILED]

    User withdraw settings request state.

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

    type stringrequired

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

    Withdraw settings type.

    balance numberrequired

    Withdraw settings balance.

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

Loading...