Skip to main content

List Pix Deposits

GET 
/v5/pix/deposits

Get a list of user's 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]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    created_at_period_start date-time

    Created at period date start for any transaction.

    created_at_period_end date-time

    Created at period date end for any transaction.

    end_to_end_id string

    PixDeposit end to end id

    txid string

    PixDeposit tx identifier

    states string[]

    Possible values: [NEW, RECEIVED, WAITING, ERROR, BLOCKED]

    PixDeposit State.

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

Responses​

The 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

    PixDeposits data.

  • Array [
    • id stringrequired

    Deposit ID.

    operation_id stringrequired

    Operation ID.

    type stringrequired

    Possible values: [DEVOLUTION_COMPLETED, DEVOLUTION_RECEIVED, DEPOSIT_RECEIVED, PAYMENT_COMPLETED]

    Transaction type.

    state stringrequired

    Possible values: [NEW, RECEIVED, WAITING, ERROR, BLOCKED]

    Deposit state.

    end_to_end_id stringrequired

    End to end id.

    txid string

    Payment txid identifier.

    amount numberrequired

    Deposit R$ in cents.

    available_amount numberrequired

    Deposit available amount.

    owner_name string

    The payment owner name.

    owner_person_type stringrequired

    Possible values: [CPF, CNPJ]

    The payment owner person document type.

    owner_document string

    The payment owner document.

    owner_bank_name stringrequired

    The payment owner bank name.

    owner_bank_ispb string

    The payment owner bank ispb.

    beneficiary_name string

    The payment beneficiary name.

    beneficiary_account_number stringrequired

    The payment beneficiary account number.

    beneficiary_branch_number stringrequired

    The payment beneficiary account branch number.

    beneficiary_person_type stringrequired

    Possible values: [CPF, CNPJ]

    The payment beneficiary person document type.

    beneficiary_document string

    The payment beneficiary document.

    beneficiary_bank_name stringrequired

    The payment beneficiary bank name.

    beneficiary_bank_ispb string

    The payment beneficiary bank ispb.

    created_at date-timerequired

    Deposit created at.

  • ]
Loading...