> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aobapay.com/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 POST /charge/pix/create
openapi: 3.1.0
info:
  title: API AobaPay
  description: API para gerenciamento de cobranças e pagamentos usando o AobaPay.
  version: 1.0.0
servers:
  - url: https://api.aobapay.com/v1
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /charge/pix/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.
                  example: 200
                  minimum: 200
                externalID:
                  type: string
                  description: ID externo para referência na sua aplicação.
                  example: '12345678900'
                expiration:
                  type: number
                  description: Tempo de expiração da cobrança em segundos.
                  example: 3600
                  minimum: 300
                comment:
                  type: string
                  maxLength: 35
                  comment: Mensagem que aparecerá na hora do pagamento do PIX.
                name:
                  type: string
                  description: Nome do pagador.
                  example: João da Silva
                email:
                  type: string
                  description: Email do pagador.
                  example: joao.silva@example.com
                phone:
                  type: string
                  description: Telefone do pagador.
                  example: '11987654321'
                document:
                  type: string
                  description: Documento do pagador (CPF ou CNPJ).
                  example: '12345678900'
                postbackUrl:
                  type: string
                  description: >-
                    URL para receber notificações sobre o status do pagamento,
                    dos eventos de cobrança paga, expirada e extornada.
                  example: https://webhook.example.com/pix
              required:
                - amount
              uniqueProperties:
                - externalID
      responses:
        '200':
          description: QRCode Pix criado com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: 'null'
                  status:
                    type: integer
                    description: Código de status HTTP.
                    example: 200
                  data:
                    $ref: '#/components/schemas/PixQRCode'
        '400':
          description: Requisição inválida. Dados fornecidos são inválidos.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Mensagem de erro descrevendo o motivo da falha.
                    example: Valor deve ser no mínimo 200
                  status:
                    type: integer
                    description: Código de status HTTP.
                    example: 400
                  data:
                    type: array
                    example: []
        '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: Header com Authorization está vazio
                  status:
                    type: integer
                    description: Código de status HTTP.
                    example: 401
                  data:
                    type: array
                    example: []
      security:
        - bearerAuth: []
components:
  schemas:
    PixQRCode:
      type: object
      properties:
        id:
          type: string
          description: Identificador único do QRCode Pix.
          example: ch_123456
        externalID:
          type: string
          description: Identificador único do QRCode Pix no seu sistema.
          example: pedido-123
        brCode:
          type: string
          description: Código copia-e-cola do QRCode Pix.
          example: 00020001021226950014br.gov.bcb.pix
        brCodeImageUrl:
          type: string
          description: Imagem em Base64 do QRCode Pix.
          example: https://api.aobapay.com/v1/qrcode/ch_abb6bc4f-f55d-45ff-8b
        amount:
          type: number
          description: Valor a ser pago.
          example: 200
        comment:
          type: string
          description: Comentário opcional sobre o QRCode Pix.
          example: 'Pagamento para pedido #123'
        expiration:
          type: integer
          description: Data de expiração do QRCode Pix em segundos.
          example: 300
        fee:
          type: number
          description: Taxas da plataforma
          example: 78
        expiresAt:
          type: string
          description: Data de expiração do QRCode Pix.
          example: '2025-09-25 13:07:27'
        status:
          type: string
          description: Informação sobre o andamento do QRCode Pix.
          enum:
            - PENDING
            - EXPIRED
            - FAILED
            - PAID
            - REFUNDED
          example: PENDING
        customer:
          type: object
          description: Dados do cliente associado ao QRCode Pix.
          additionalProperties: false
          properties:
            id:
              type: string
              description: Identificador único do cliente.
              example: cus_2243f989-f044-49cc-84db-3ff9e4908dde
            name:
              type: string
              description: Nome do cliente.
              example: João da Silva
            document:
              type: string
              description: Documento do cliente (CPF ou CNPJ).
              example: '12345678900'
            email:
              type: string
              description: Endereço de e-mail do cliente.
              example: brendo.silva@example.com
            phone:
              type: string
              description: Número de telefone do cliente.
              example: '+5511987654321'
        createdAt:
          type: string
          description: Data de criação do QRCode Pix.
          example: '2025-09-25 13:07:27'
        updatedAt:
          type: string
          description: Data de atualização do QRCode Pix.
          example: '2025-09-25 13:07:27'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer <aobapay-api-key>`
        onde `<aobapay-api-key>` é a sua chave de API.

````