Skip to main content

Get Pix Devolution by ID (V4)

GET 
/v4/pix/devolutions/:id

Retrieve the state and details of a pix devolution by providing its ID. Uses wallet ID only.

Request​

Path Parameters

    id stringrequired

    Devolution 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 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

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

The PIX devolution returned successfully.

Schema
    id stringrequired

    Devolution ID.

    description string

    User defined devolution description.

    failed_message stringnullable

    Error returned when devolution is reverted.

    operation_id stringrequired

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

    end_to_end_id string

    End to End ID.

    txid string

    Payment txid identifier.

    amount numberrequired

    Value in R$ cents.

    state stringrequired

    Possible values: [PENDING, WAITING, WAITING_DELAYED, CONFIRMED, ERROR, FAILED, CANCELED]

    Devolution state.

    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 created at.

Loading...