List allow/block list cashout entries

GET 
/v1/permissions/allow-block-lists/cashout/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]

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

200

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Array [
id stringrequired
wallet_id stringrequired
type stringrequired
Possible values: [DOCUMENT]
document_type stringrequired
Possible values: [CPF, CNPJ]
document stringrequired
created_at date-timerequired
updated_at date-timerequired
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "string",
      "wallet_id": "string",
      "type": "DOCUMENT",
      "document_type": "CPF",
      "document": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}

Loading...