PaymentInstructionResponseDTO

Full state of a payment instruction (a single charge within an active mandate).

  • acceptedAt
    Type: string Format: date-time

    Timestamp the instruction became ACCEPTED (after pain.014 ACSP)

  • amount
    Type: number

    Amount to collect (BRL)

  • cancellationId
    Type: string

    BACEN cancellation id (returned in camt.029)

  • cancellationReason
    Type: string

    BACEN cancellation reason code

  • cancelledAt
    Type: string Format: date-time

    Timestamp of cancellation

  • cancelledBy
    Type: string enum

    Who cancelled the instruction

    values
    • SELF
    • COUNTERPARTY
  • createdAt
    Type: string Format: date-time

    Record creation timestamp

  • description
    Type: string

    Free-text description from the receiver

  • endToEndId
    Type: string

    End-to-end identifier (BACEN format E + ISPB + timestamp + random)

  • expiryDate
    Type: string Format: date

    Last day the user can approve the charge before it expires

  • localInstrument
    Type: string

    BACEN local instrument (always AUTO for Pix Automatico)

  • mandateId
    Type: string

    Parent mandate id this charge belongs to

  • purpose
    Type: string enum

    Purpose of the automatic Pix payment (SPI purpose codes)

    values
    • AUTO
    • GSCB
    • IPAY
    • IPRT
    • OTHR
    • REFU
  • receivedAt
    Type: string Format: date-time

    Timestamp the original pain.013 was received

  • receiver
    Type: object · ReceiverDTO2

    Receiver/beneficiary information

    • document
      Type: object · DocumentDTO2
      required

      Document identification (CPF or CNPJ)

    • name
      Type: string
      min length:  
      1
      required

      Receiver full name.

    • account
      Type: object · AccountDTO2

      Bank account information

    • key
      Type: string

      Receiver Pix key.

  • rejectedAt
    Type: string Format: date-time

    Timestamp of rejection

  • rejectReason
    Type: string

    BACEN reject reason code

  • requestedExecutionDate
    Type: string Format: date-time

    When the charge should be executed

  • sender
    Type: object · SenderDTO2

    Payer/sender information

    • account
      Type: object · AccountDTO2

      Bank account information

    • document
      Type: object · DocumentDTO2

      Document identification (CPF or CNPJ)

    • name
      Type: string

      Participant full name.

  • settledAt
    Type: string Format: date-time

    Timestamp of final settlement (after pacs.002)

  • status
    Type: string enum

    Current instruction status

    values
    • PENDING_USER_APPROVAL
    • APPROVAL_SENT
    • ACCEPTED
    • SETTLED
    • REJECTED
    • CANCELLED
    • EXPIRED
    • FAILED
  • updatedAt
    Type: string Format: date-time

    Last update timestamp