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

# Simular Pagamento

> Simula o pagamento de um QRCode Pix criado no modo de desenvolvimento.

Simula o pagamento de um QR Code PIX no ambiente de desenvolvimento. Só funciona com chaves de API de sandbox.

<Card horizontal>
  Requer a permissão `CHECKOUT:READ`. Disponível apenas em `devMode`.
</Card>

Use para testar o fluxo completo sem precisar realizar um PIX real: crie um QR Code, simule o pagamento e confirme que seu webhook ou polling recebe o status `PAID`.

<Note>
  Em produção este endpoint retorna erro. Ative o [modo de desenvolvimento](/pages/devmode) para usá-lo.
</Note>


## OpenAPI

````yaml POST /transparents/simulate-payment
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/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /transparents/simulate-payment:
    post:
      summary: Simular Pagamento
      description: Simula o pagamento de um QRCode Pix criado no modo de desenvolvimento.
      parameters:
        - name: id
          in: query
          description: Identificador único do Checkout Transparente
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  description: Metadados opcionais para a requisição
                  default: {}
      responses:
        '200':
          description: Pagamento ralizado com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PixQRCode'
                  error:
                    type: string
                    nullable: true
                    example: null
                  success:
                    $ref: '#/components/schemas/Success'
        '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
            - UNDER_DISPUTE
            - REFUNDED
            - REDEEMED
            - APPROVED
            - FAILED
          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
        receiptUrl:
          type: string
          format: uri
          nullable: true
          description: >-
            URL do comprovante de pagamento. Preenchido após o pagamento ser
            confirmado; `null` enquanto a cobrança estiver pendente.
          example: null
        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'
        metadata:
          type: object
          description: Metadados opcionais da cobrança.
          additionalProperties: true
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````