> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar uma Cobrança Imediata

> Use este endpoint para atualizar uma cobrança imediata. Apenas cobranças no status ACTIVE podem ser atualizadas.

**Campos Mutáveis (podem ser atualizados):**
- expirationSeconds: Tempo em segundos até a cobrança expirar
- receiverKey: Chave PIX que receberá o pagamento
- debtorDocument: CPF/CNPJ do pagador (deve ser informado junto com debtorName)
- debtorName: Nome do pagador (deve ser informado junto com debtorDocument)
- description: Descrição personalizada da cobrança
- additionalInfo: Informações adicionais em pares chave-valor
- tags: Array de tags personalizadas

**Campos Imutáveis (não podem ser atualizados):**
- id: Identificador único da cobrança
- accountId: Identificador da conta
- txId: Identificador da transação
- amount: Valor original da cobrança
- status: Status da cobrança (gerenciado pelo sistema)
- pactualId: ID do provedor externo
- emv: Payload do QR Code
- locationUrl: URL do QR Code
- createdAt: Timestamp de criação
- updatedAt: Timestamp da última atualização

**Restrições de Estado:**
- As cobranças SÓ podem ser atualizadas quando o status é ACTIVE
- Cobranças com status COMPLETED, DELETED ou EXPIRED não podem ser atualizadas



## OpenAPI

````yaml pt/openapi/v3-current/indirect-pix.yaml PUT /v1/collections/immediate/{collection_id}
openapi: 3.0.3
info:
  title: Plugin BR Pix Indireto - API Completa
  description: |
    API completa para o sistema brasileiro de pagamentos instantâneos Pix,
    incluindo operações de dicionário de chaves Pix, geração/decodificação de
    QR Code, transações e limites de transações.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/collections/immediate/{collection_id}:
    put:
      tags:
        - Collections API
      summary: Atualizar uma Cobrança Imediata
      description: >-
        Use este endpoint para atualizar uma cobrança imediata. Apenas cobranças
        no status ACTIVE podem ser atualizadas.


        **Campos Mutáveis (podem ser atualizados):**

        - expirationSeconds: Tempo em segundos até a cobrança expirar

        - receiverKey: Chave PIX que receberá o pagamento

        - debtorDocument: CPF/CNPJ do pagador (deve ser informado junto com
        debtorName)

        - debtorName: Nome do pagador (deve ser informado junto com
        debtorDocument)

        - description: Descrição personalizada da cobrança

        - additionalInfo: Informações adicionais em pares chave-valor

        - tags: Array de tags personalizadas


        **Campos Imutáveis (não podem ser atualizados):**

        - id: Identificador único da cobrança

        - accountId: Identificador da conta

        - txId: Identificador da transação

        - amount: Valor original da cobrança

        - status: Status da cobrança (gerenciado pelo sistema)

        - pactualId: ID do provedor externo

        - emv: Payload do QR Code

        - locationUrl: URL do QR Code

        - createdAt: Timestamp de criação

        - updatedAt: Timestamp da última atualização


        **Restrições de Estado:**

        - As cobranças SÓ podem ser atualizadas quando o status é ACTIVE

        - Cobranças com status COMPLETED, DELETED ou EXPIRED não podem ser
        atualizadas
      parameters:
        - name: collection_id
          in: path
          description: Identificador da cobrança imediata
          required: true
          schema:
            type: string
        - name: X-Account-Id
          in: header
          description: ID da Conta (formato UUID)
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateImmediateCollectionInput'
      responses:
        '200':
          description: Cobrança atualizada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImmediateCollectionOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    UpdateImmediateCollectionInput:
      properties:
        additionalInfo:
          additionalProperties:
            type: string
          description: >-
            AdditionalInfo é o novo mapa de chave-valor para informações
            adicionais
          example:
            status: updated
            version: '2'
          type: object
        amount:
          description: >-
            Amount é o novo valor da cobrança em formato decimal com 2 casas
            decimais
          example: '150.00'
          type: string
        debtorDocument:
          description: >-
            DebtorDocument é o novo CPF ou CNPJ do pagador (deve ser informado
            junto com DebtorName)
          example: '98765432109'
          type: string
        debtorName:
          description: >-
            DebtorName é o novo nome do pagador (deve ser informado junto com
            DebtorDocument)
          example: Maria Santos
          type: string
        description:
          description: Description é a nova descrição personalizada para a cobrança
          example: Descrição de pagamento atualizada
          type: string
        expirationSeconds:
          description: >-
            ExpirationSeconds é o novo tempo de expiração em segundos (deve ser
            maior que 0)
          example: 7200
          type: integer
        metadata:
          additionalProperties: {}
          description: >-
            Metadata é um mapa para atualizar pares de chave-valor
            personalizados (merge patch RFC 7386)
          type: object
        receiverKey:
          description: Nova chave Pix que receberá o pagamento
          example: '+5511988888888'
          minLength: 1
          type: string
        tags:
          description: Tags é o novo array de tags personalizadas
          example:
            - updated
            - revised
          items:
            type: string
          type: array
      type: object
    ImmediateCollectionOutput:
      properties:
        additionalInfo:
          additionalProperties:
            type: string
          description: AdditionalInfo contém informações adicionais de chave-valor
          example:
            customerId: '67890'
            orderId: '12345'
          type: object
        amount:
          description: Amount é o valor da cobrança em formato decimal
          example: '100.00'
          type: string
        createdAt:
          description: CreatedAt é o timestamp de quando a cobrança foi criada
          example: '2024-01-15T10:30:00Z'
          type: string
        debtorDocument:
          description: DebtorDocument é o CPF ou CNPJ do pagador
          example: '12345678901'
          type: string
        debtorName:
          description: DebtorName é o nome do pagador
          example: João da Silva
          type: string
        description:
          description: Description é a descrição personalizada da cobrança
          example: 'Payment for order #12345'
          type: string
        emv:
          description: EMV é o payload do QR code no formato EMV
          example: 00020126580014br.gov.bcb.pix...
          type: string
        expirationSeconds:
          description: ExpirationSeconds é o tempo em segundos até a expiração
          example: 3600
          type: integer
        id:
          description: ID é o identificador único da cobrança
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        locationUrl:
          description: LocationURL é a URL para acessar a localização/QR code da cobrança
          example: https://api.example.com/qr/550e8400
          type: string
        metadata:
          additionalProperties: {}
          description: Metadata são os metadados personalizados associados a esta cobrança
          type: object
        receiverKey:
          description: Chave Pix que receberá o pagamento
          example: '+5511999999999'
          type: string
        status:
          description: Status é o status atual da cobrança
          example: ACTIVE
          type: string
        tags:
          description: Tags é um array de tags personalizadas
          example:
            - ecommerce
            - subscription
          items:
            type: string
          type: array
        txId:
          description: TxID é o identificador da transação
          example: TXN123456789
          type: string
        updatedAt:
          description: UpdatedAt é o timestamp da última atualização
          example: '2024-01-15T10:30:00Z'
          type: string
      type: object
    ErrorFormat:
      type: object
      description: A mensagem de erro da resposta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Um identificador único e estável para o erro.
        title:
          type: string
          description: Um breve resumo do problema.
        message:
          type: string
          description: Orientação detalhada para resolver o erro.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````