Skip to main content

Get Pix Deposit by ID

GET 
/v2/pix/deposits/:id
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Retrieve the state and details of a pix deposit by providing its ID.

Request​

Path Parameters

    id stringrequired

    Deposit UUID.

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​

Deposit.

Schema
    id stringrequired

    Deposit ID.

    operation_id stringrequired

    Operation ID.

    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.

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