PixRequestOutDTO

Request payload for creating an outgoing Pix payment

  • amount
    Type: number
    required

    Transaction amount.

  • initiationMethod
    Type: string enum
    required

    Payment initiation method.

    values
    • APDN
    • APES
    • AUTO
    • DICT
    • INIC
    • MANU
    • QRDN
    • QRES
  • receiver
    Type: object · ReceiverDTO
    required

    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. Required when initiationMethod is DICT, QRDN, QRES, APDN, APES or INIC; must be absent for MANU and AUTO. Carried to pacs.008 CdtrAcct/Prxy/Id.

  • sender
    Type: object · SenderDTO
    required

    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.

  • cashAmount
    Type: string

    Cash-out withdrawal amount (Pix Saque / Pix Troco).

  • cashierIspb
    Type: string

    ISPB of the cashier institution.

  • cashierType
    Type: string enum

    Type of cashier performing the Pix cash-out withdrawal

    values
    • MERCHANT
    • PARTICIPANT
    • OTHER
  • description
    Type: string

    Payment description or message to the receiver.

  • endToEndId
    Type: string

    End-to-end identifier. Optional: when supplied it is honored and preserved unchanged through to the SPI (immutable per BACEN). Omit to have it generated automatically.

  • initiator
    Type: object · InitiatorDTO

    Payment initiator (ITP) identification. Required when initiationMethod is INIC.

    • document
      Type: string
      min length:  
      1
      required

      Initiator CNPJ.

    • name
      Type: string
      max length:  
      150
      required

      Initiator legal name.

  • mandateId
    Type: string
    max length:  
    35

    Mandate identifier. Required when source=PIX_AUTOMATIC; propagated to the pacs.008 MndtRltdInf.MandateId.

  • metadata
    Type: array object[] · MetadataDTO[]

    Optional list of custom 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

  • priority
    Type: string enum

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

    values
    • HIGH
    • NORM
  • purpose
    Type: string enum

    Purpose of the outgoing Pix payment (SPI purpose codes)

    values
    • GSCB
    • IPAY
    • IPRT
    • OTHR
    • REFU
  • reconciliationId
    Type: string

    Client reconciliation identifier for reporting and matching. Alphanumeric only ([a-zA-Z0-9]); the length depends on initiationMethod: up to 25 for QRES, APES and INIC, and 26 to 35 for QRDN, APDN and AUTO.

  • scheduleId
    Type: string Format: uuid

    Schedule ID that originated this Pix payment (when executed from a schedule).

  • source
    Type: string enum

    Origin of the payment. Defaults to MANUAL. Use PIX_AUTOMATIC when the payment is being executed on behalf of an approved pain.013 instruction.

    values
    • MANUAL
    • PIX_AUTOMATIC