PixRefundOutResponseDTO

Response representing an outgoing Pix refund request

  • amount
    Type: number

    Transaction amount in BRL

  • createdAt
    Type: string Format: date-time

    Timestamp when the request was created

  • description
    Type: string

    Payment description or message to the receiver

  • id
    Type: string

    Unique identifier of the Pix request

  • initiationMethod
    Type: string enum

    Payment initiation method

    values
    • APDN
    • APES
    • AUTO
    • DICT
    • INIC
    • MANU
    • QRDN
    • QRES
  • metadata
    Type: array object[] · MetadataDTO[]

    Custom metadata key/value pairs stored with the request

    Key/value metadata item

    • key
      Type: string
      min length:  
      1
      required

      Metadata key

    • value
      Type: string

      Metadata value

  • pixIdentifiers
    Type: object · PixRefundIdentifiersDTO

    Pix refund transaction identifiers generated by the payment infrastructure

    • originalEndToEndId
      Type: string

      Original end-to-end identifier (present in refund transactions)

    • refundNumber
      Type: integer Format: int32

      Sequential number of this refund for the original E2E (first refund = 1, second = 2, ...)

    • returnId
      Type: string

      Return identifier of the Pix refund transaction

    • txId
      Type: string

      Transaction identifier (TxId)

  • priority
    Type: string enum

    Payment priority for the outgoing Pix request (SPI band: HIGH → HIGH, NORM → NORM)

    values
    • HIGH
    • NORM
  • receiver
    Type: object · ReceiverDTO

    Receiver/beneficiary information for the Pix transaction

    • document
      Type: object · DocumentDTO
      required

      Document identification (CPF or CNPJ)

    • name
      Type: string
      min length:  
      1
      required

      Receiver full name.

    • account
      Type: object · AccountDTO

      Bank account information

    • key
      Type: string

      Receiver Pix key.

  • reconciliationId
    Type: string

    Client reconciliation identifier for reporting and matching

  • remainingAmount
    Type: string

    Remaining amount still available for refund on the original Pix transaction, after this refund is applied

  • sender
    Type: object · SenderDTO

    Payer/sender information for the Pix transaction

    • account
      Type: object · AccountDTO
      required

      Bank account information

    • document
      Type: object · DocumentDTO
      required

      Document identification (CPF or CNPJ)

    • name
      Type: string
      min length:  
      1
      required

      Participant full name.

  • status
    Type: string enum

    Current status of the Pix request

    values
    • ACCEPTED
    • SETTLED
    • REJECTED
    • CANCELED
    • FAILED