> ## Documentation Index
> Fetch the complete documentation index at: https://abacatepay-feat-lojista.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar QRCode PIX

> Permite que você crie um código copia-e-cola e um QRCode Pix para seu cliente fazer o pagamento.



## OpenAPI

````yaml /openapi-v1.yaml post /pixQrCode/create
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v1
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /pixQrCode/create:
    post:
      summary: Criar QRCode PIX
      description: >-
        Permite que você crie um código copia-e-cola e um QRCode Pix para seu
        cliente fazer o pagamento.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  description: Valor da cobrança em centavos.
                expiresIn:
                  type: number
                  description: Tempo de expiração da cobrança em segundos.
                description:
                  type: string
                  maxLength: 37
                  description: >-
                    Mensagem que aparecerá na hora do pagamento do PIX.
                    Caracteres além de 37 serão ignorados no registro.
                customer:
                  type: object
                  description: >
                    Os dados do seu cliente para criá-lo.

                    O objeto de customer não é obrigatório, mas ao informar
                    qualquer informação do `customer` todos os campos `name`,
                    `cellphone`, `email` e `taxId` são obrigatórios.
                  required:
                    - name
                    - cellphone
                    - email
                    - taxId
                  additionalProperties: false
                  properties:
                    name:
                      type: string
                      description: Nome completo do seu cliente
                      example: Daniel Lima
                    cellphone:
                      type: string
                      description: Celular do cliente
                      example: (11) 4002-8922
                    email:
                      type: string
                      description: E-mail do cliente
                      example: daniel_lima@abacatepay.com
                    taxId:
                      type: string
                      description: CPF ou CNPJ do cliente.
                      example: 123.456.789-01
                metadata:
                  type: object
                  description: Metadados opcionais para a cobrança
                  additionalProperties: true
                  default:
                    externalId: '123'
              required:
                - amount
              additionalProperties: false
      responses:
        '200':
          description: QRCode Pix criado com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PixQRCode'
                  error:
                    type: 'null'
                    example: null
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro descrevendo o motivo da falha na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
      security:
        - bearerAuth: []
components:
  schemas:
    PixQRCode:
      type: object
      properties:
        id:
          type: string
          description: Identificador único do QRCode Pix.
          example: pix_char_123456
        amount:
          type: number
          description: Valor a ser pago.
          example: 100
        status:
          type: string
          description: Informação sobre o andamento do QRCode Pix.
          enum:
            - PENDING
            - EXPIRED
            - CANCELLED
            - PAID
            - REFUNDED
          example: PENDING
        devMode:
          type: boolean
          description: Ambiente no qual o QRCode Pix foi criado.
          example: true
        brCode:
          type: string
          description: Código copia-e-cola do QRCode Pix.
          example: 00020101021226950014br.gov.bcb.pix
        brCodeBase64:
          type: string
          description: Imagem em Base64 do QRCode Pix.
          example: data:image/png;base64,iVBORw0KGgoAAA
        platformFee:
          type: number
          description: Taxas da plataforma
          example: 80
        createdAt:
          type: string
          description: Data de criação do QRCode Pix.
          example: '2025-03-24T21:50:20.772Z'
        updatedAt:
          type: string
          description: Data de atualização do QRCode Pix.
          example: '2025-03-24T21:50:20.772Z'
        expiresAt:
          type: string
          description: Data de expiração do QRCode Pix
          example: '2025-03-25T21:50:20.772Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer
        <abacatepay-api-key>` onde `<abacatepay-api-key>` é a sua chave de API.

````