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

# Gerar QR Code Dinâmico

> Use este endpoint para criar um QR Code dinâmico que pode ser utilizado para depósitos via Pix.



## OpenAPI

````yaml api-reference/openapi.json post /pix/create_pix_qrcode
openapi: 3.1.0
info:
  title: Noodle API
  contact:
    name: Time de Engenharia da Noodle
    url: https://www.noodle.cx/contato
    email: dev@noodle.cx
  version: 1.0.0
servers:
  - url: https://production.api.noodle.cx/external
    description: Servidor de Produção
  - url: https://homolog.api.noodle.cx/external
    description: Servidor de Homologação (Staging)
security: []
paths:
  /pix/create_pix_qrcode:
    post:
      tags:
        - Pix
      summary: Gerar QR Code Dinâmico
      description: >-
        Use este endpoint para criar um QR Code dinâmico que pode ser utilizado
        para depósitos via Pix.
      operationId: create_dynamic_pix_payment_pix_create_pix_qrcode_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDynamicPixPaymentModel'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicPixPaymentModel'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    CreateDynamicPixPaymentModel:
      properties:
        receiver_conciliation_id:
          type: string
          title: Receiver Conciliation Id
          description: ID de conciliação do recebedor.
        amount:
          type: number
          title: Amount
          description: Valor do pagamento.
        occurrence_type:
          type: string
          title: Occurrence Type
          description: Tipo de ocorrência do pagamento.
        payer_document_number:
          type: string
          title: Payer Document Number
          description: CPF ou CNPJ do pagador.
        payer_name:
          type: string
          title: Payer Name
          description: Nome do pagador.
        payer_person_type:
          type: string
          title: Payer Person Type
          description: Tipo de pessoa do pagador (física ou jurídica).
        payer_request:
          type: string
          title: Payer Request
          description: Solicitação ou mensagem do pagador.
        pix_key:
          type: string
          title: Pix Key
          description: Chave Pix do recebedor.
        qr_code_type:
          type: string
          title: Qr Code Type
          description: Tipo de QR Code (estático ou dinâmico).
        additional_data:
          items:
            $ref: '#/components/schemas/AdditionalPixData'
          type: array
          title: Additional Data
          description: Lista de dados adicionais para o pagamento.
        expiration_seconds:
          type: integer
          title: Expiration Seconds
          description: >-
            indica qual o tempo de validade do QR Code em segundos, padrão 1
            dia.
          default: 864000
      type: object
      required:
        - receiver_conciliation_id
        - amount
        - occurrence_type
        - payer_document_number
        - payer_name
        - payer_person_type
        - payer_request
        - pix_key
        - qr_code_type
        - additional_data
      title: CreateDynamicPixPaymentModel
      description: >-
        Representa os dados necessários para criar um pagamento dinâmico via
        Pix.


        **Atributos**:

        - **receiver_conciliation_id** (*str*): ID de conciliação do recebedor.

        - **amount** (*float*): Valor do pagamento.

        - **occurrence_type** (*str*): Tipo de ocorrência do pagamento.

        - **payer_document_number** (*str*): CPF ou CNPJ do pagador.

        - **payer_name** (*str*): Nome do pagador.

        - **payer_person_type** (*str*): Tipo de pessoa do pagador (física ou
        jurídica).

        - **payer_request** (*str*): Solicitação ou mensagem do pagador.

        - **pix_key** (*str*): Chave Pix do recebedor.

        - **qr_code_type** (*str*): Tipo de QR Code (estático ou dinâmico).

        - **additional_data** (*list[AdditionalPixData]*): Lista de dados
        adicionais para o pagamento.
    DynamicPixPaymentModel:
      properties:
        amount:
          type: number
          title: Amount
          description: Valor do pagamento.
        receiver_conciliation_id:
          type: string
          title: Receiver Conciliation Id
          description: ID de conciliação do recebedor.
        pix_key:
          type: string
          title: Pix Key
          description: Chave Pix do recebedor.
        qr_code_key:
          type: string
          title: Qr Code Key
          description: Chave do QR Code gerado.
        base_64:
          type: string
          title: Base 64
          description: Representação em Base64 do QR Code.
        image:
          type: string
          title: Image
          description: URL ou caminho da imagem do QR Code.
      type: object
      required:
        - amount
        - receiver_conciliation_id
        - pix_key
        - qr_code_key
        - base_64
        - image
      title: DynamicPixPaymentModel
      description: |-
        Representa os dados de um pagamento dinâmico via Pix.

        **Atributos**:
        - **amount** (*float*): Valor do pagamento.
        - **receiver_conciliation_id** (*str*): ID de conciliação do recebedor.
        - **pix_key** (*str*): Chave Pix do recebedor.
        - **qr_code_key** (*str*): Chave do QR Code gerado.
        - **base_64** (*str*): Representação em Base64 do QR Code.
        - **image** (*str*): URL ou caminho da imagem do QR Code.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AdditionalPixData:
      properties:
        key_name:
          type: string
          title: Key Name
          description: Nome da chave do dado adicional.
        value:
          type: string
          title: Value
          description: Valor associado à chave do dado adicional.
      type: object
      required:
        - key_name
        - value
      title: AdditionalPixData
      description: |-
        Representa dados adicionais para um pagamento via Pix.

        **Atributos**:
        - **key_name** (*str*): Nome da chave do dado adicional.
        - **value** (*str*): Valor associado à chave do dado adicional.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.