PixRequestOutRefundDTO

Request payload for refunding an outgoing Pix transaction

  • amount
    Type: number
    required

    Refund amount.

  • originalEndToEndId
    Type: string
    min length:  
    1
    required

    Original end-to-end ID of the transaction to be refunded.

  • reason
    Type: string enum
    required

    Refund reason.

    values
    • CUSTOMER_REQUEST
    • WITHDRAWAL
    • TECHNICAL_ERROR
    • FRAUD
  • description
    Type: string

    Optional refund description forwarded to the SPI call.

  • returnId
    Type: string

    Refund identifier (pacs.004 RtrId). Optional: when supplied it is honored as the refund identifier instead of being generated internally, and is forwarded unchanged to the SPI. Callers that need to know the identifier before dispatch — to correlate the settlement event back to their own record — pin it here. Omit to have it generated automatically.