Skip to main content

Get Received Pix Devolution by ID

GET 
/v2/pix/devolutions-received/:id

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

Request​

Path Parameters

    id stringrequired

    Devolution Received ID.

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 PIX devolution received returned successfully.

Schema
    id stringrequired

    Devolution ID.

    description string

    User defined devolution description.

    state stringrequired

    Possible values: [READY, ERROR]

    Devolution state.

    operation_id stringrequired

    Operation UUID. Used to get receipt and track the transaction.

    original_id string

    Original Payment ID.

    original_end_to_end_id string

    Original Payment End to End ID.

    end_to_end_id string

    End to End ID.

    txid string

    Payment txid identifier.

    amount numberrequired

    Value in R$ cents.

    owner_name string

    The payment owner name.

    owner_person_type stringrequired

    Possible values: [CPF, CNPJ]

    The payment owner person type.

    owner_document string

    The payment owner document.

    owner_bank_name stringrequired

    The payment owner bank name.

    beneficiary_name string

    The payment beneficiary name.

    beneficiary_person_type stringrequired

    Possible values: [CPF, CNPJ]

    The payment beneficiary person type.

    beneficiary_document string

    The payment beneficiary document.

    beneficiary_bank_name stringrequired

    The payment beneficiary bank name.

    created_at date-timerequired

    Devolution received created at.

Loading...