Skip to main content

List Warning Pix Deposits

GET 
/v1/pix/warning/deposits

Get a list of user's warning pix deposits. You can include any of the filter parameters below to refine your search.

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, updated_at, state]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    transaction_tag string

    Transaction tag.

    states string[]

    Possible values: [CREATED, APPROVED, REJECTED, APPROVED_BY_USER]

    Warning Pix Deposit states.

    created_at_period_start date-time

    Created at start date period for warning transactions.

    created_at_period_end date-time

    Created at end date period for warning transactions.

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 warning pix deposits 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

    Warning Pix Deposits data.

  • Array [
    • id stringrequired
    operation_id stringrequired

    Operation UUID.

    transaction_tag stringrequired

    Transaction tag.

    state stringrequired

    Possible values: [CREATED, APPROVED, REJECTED, APPROVED_BY_USER]

    Warning pix deposit state.

    rejected_reason stringnullable

    Warning pix deposit rejected reason.

    amount numbernullable

    Pix deposit amount.

    third_part_name stringnullable

    Pix deposit payer name.

    failed_checks array[]nullable

    List of failed validation checks that triggered the warning.

    created_at date-timerequired

    Date of created Warning Pix Deposit.

    updated_at date-timerequired

    Date of updated Warning Pix Deposit.

  • ]
Loading...