Skip to main content

List Allow/Block List cashout entries

GET 
/v1/permissions/allow-block-lists/cashout/entries

Lists the wallet Allow/Block List entries.Tag: api-paas-get-permissions-allow-block-lists-cashout-entries

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.

    document_type string

    Possible values: [CPF, CNPJ]

    Filter entries by document type.

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.

Responses​

Allow/Block List cashout entries listed.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Allow/Block List cashout entries.

  • Array [
    • id stringrequired

    Entry ID.

    allow_block_list_id stringrequired

    Allow/Block List ID.

    wallet_id stringrequired

    Wallet ID.

    type stringrequired

    Possible values: [DOCUMENT]

    Entry type.

    document_type stringrequired

    Possible values: [CPF, CNPJ]

    Recipient document type.

    document stringrequired

    Recipient document (CPF or CNPJ). The CNPJ may be alphanumeric.

    created_at date-timerequired

    Entry created at.

    updated_at date-timerequired

    Entry updated at.

  • ]
Loading...