CashWithdrawalDTO

Cash-out withdrawal (Pix Saque/Troco). Carries withdrawal XOR change.

  • saque
    Type: object · CashWithdrawalDetailDTO

    Cash-out withdrawal (saque) or change (troco) detail

    • valor
      Type: string
      min length:  
      1
      required

      Cash-out withdrawal/change amount, 2 decimals

    • modalidadeAgente
      Type: string enum

      Withdrawal agent modality (Bacen modalidadeAgente)

      values
      • AGTEC
      • AGTOT
      • AGPSS
    • modalidadeAlteracao
      Type: integer Format: int32
      min:  
      0
      max:  
      1      enum

      Change mode: 0 = fixed (default), 1 = payer can change

      values
      • 0
      • 1
    • prestadorDoServicoDeSaque
      Type: string

      ISPB (8 chars, [0-9A-Z]) of the withdrawal service facilitator (FSS)

  • troco
    Type: object · CashWithdrawalDetailDTO

    Cash-out withdrawal (saque) or change (troco) detail

    • valor
      Type: string
      min length:  
      1
      required

      Cash-out withdrawal/change amount, 2 decimals

    • modalidadeAgente
      Type: string enum

      Withdrawal agent modality (Bacen modalidadeAgente)

      values
      • AGTEC
      • AGTOT
      • AGPSS
    • modalidadeAlteracao
      Type: integer Format: int32
      min:  
      0
      max:  
      1      enum

      Change mode: 0 = fixed (default), 1 = payer can change

      values
      • 0
      • 1
    • prestadorDoServicoDeSaque
      Type: string

      ISPB (8 chars, [0-9A-Z]) of the withdrawal service facilitator (FSS)