Skip to main content

Create Allow/Block List cashout

POST 
/v1/permissions/allow-block-lists/cashout

Creates the Allow/Block List cashout config. Only one active config is allowed per wallet.Retrying with the same x-transaction-id returns the config already created instead of an error; use the update operation to change it.Tag: api-paas-post-permissions-allow-block-lists-cashout

Request​

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

    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.

Body

required
    mode stringrequired

    Possible values: [ALLOW, BLOCK]

    List mode. ALLOW: cashouts are sent only to documents in the wallet list. BLOCK: cashouts to documents in the wallet list are rejected.

    legal_person_only boolean

    When true, the Allow List is enforced only for recipients that are legal persons; cashouts to natural persons bypass it. Only applies when mode is ALLOW; ignored (stored as false) for BLOCK. Defaults to false.

Responses​

Allow/Block List cashout config created.

Schema
    id stringrequired

    Allow/Block List cashout config ID.

    wallet_id stringrequired

    Wallet ID.

    mode stringrequired

    Possible values: [ALLOW, BLOCK]

    List mode. ALLOW: cashouts are sent only to documents in the wallet list. BLOCK: cashouts to documents in the wallet list are rejected.

    legal_person_only booleanrequired

    When true, the Allow List is enforced only for recipients that are legal persons; cashouts to natural persons bypass it.

    created_at date-timerequired

    Config created at.

    updated_at date-timerequired

    Config updated at.

Loading...