Skip to main content

GetAllPixDevolutionRestResponse

    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    PixDevolutions data.

  • Array [
  • 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.

    type stringrequired

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

    Transaction type.

    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.

  • ]