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

# Simular resultado de pagamento

> Força o desfecho de um payment intent de teste: aprovar, recusar ou expirar. Disponível apenas com chaves `kbt_test_` — no sandbox não existe "pagar de verdade".



## OpenAPI

````yaml /openapi/korbit-public-v1.json post /v1/sandbox/payment-intents/{id}/simulate
openapi: 3.1.0
info:
  title: Korbit API
  version: 1.0.0
  description: >-
    API de pagamentos da Korbit para merchants: PIX, cartão (com 3DS),
    assinaturas, checkout por link, payouts, antecipações e refunds — com
    idempotência, webhooks assinados e ambiente sandbox.
  contact:
    name: Suporte Korbit
    email: suporte@korbit.com.br
servers:
  - url: https://api.korbit.com.br
    description: Produção (chaves kbt_live_)
  - url: https://api-test.korbit.com.br
    description: Sandbox (chaves kbt_test_)
security:
  - bearerAuth: []
tags:
  - name: Antecipações
  - name: Assinaturas
  - name: Atividade
  - name: Catálogo
  - name: Chaves de API
  - name: Checkout
  - name: Clientes e Pedidos
  - name: Pagamentos
  - name: Refunds e Disputas
  - name: Saldo e Saques
  - name: Sandbox
  - name: Webhooks
paths:
  /v1/sandbox/payment-intents/{id}/simulate:
    post:
      tags:
        - Sandbox
      summary: Simular resultado de pagamento
      description: >-
        Força o desfecho de um payment intent de teste: aprovar, recusar ou
        expirar. Disponível apenas com chaves `kbt_test_` — no sandbox não
        existe "pagar de verdade".
      operationId: simulateSandboxPaymentIntent
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: id
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - scenario
              properties:
                scenario:
                  type: string
                  enum:
                    - pix.paid
                    - pix.expired
                    - card.auth_required
                    - card.approved
                    - card.declined_insufficient_funds
                    - card.declined_generic
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - amount
                  - createdAt
                  - currency
                  - description
                  - externalReference
                  - id
                  - metadata
                  - paymentMethod
                  - pix
                  - status
                  - updatedAt
                properties:
                  cardAction:
                    type: object
                    additionalProperties: false
                    required:
                      - type
                      - externalResourceUrl
                      - creq
                      - expiresAt
                    properties:
                      type:
                        enum:
                          - THREE_DS
                      externalResourceUrl:
                        type: string
                        format: uri
                        maxLength: 2048
                        pattern: ^https://
                      creq:
                        type: string
                        minLength: 1
                        maxLength: 16384
                        pattern: ^[A-Za-z0-9_=-]+$
                      expiresAt:
                        type: string
                        format: date-time
                  amount:
                    type: integer
                    minimum: 1
                    maximum: 9007199254740991
                  createdAt:
                    type: string
                    format: date-time
                  currency:
                    type: string
                    enum:
                      - BRL
                  description:
                    anyOf:
                      - type: string
                        maxLength: 200
                      - type: 'null'
                  externalReference:
                    anyOf:
                      - type: string
                        maxLength: 128
                      - type: 'null'
                  id:
                    type: string
                    format: uuid
                  metadata:
                    type: object
                    maxProperties: 20
                    additionalProperties:
                      type: string
                      maxLength: 500
                  paymentMethod:
                    type: string
                    enum:
                      - PIX
                      - CARD
                  pix:
                    anyOf:
                      - type: object
                        additionalProperties: false
                        required:
                          - copyAndPaste
                          - expiresAt
                        properties:
                          copyAndPaste:
                            type: string
                            minLength: 1
                            maxLength: 4096
                          expiresAt:
                            type: string
                            format: date-time
                      - type: 'null'
                  status:
                    type: string
                    enum:
                      - CREATED
                      - PROCESSING
                      - REQUIRES_ACTION
                      - SUCCEEDED
                      - FAILED
                      - CANCELED
                      - EXPIRED
                  updatedAt:
                    type: string
                    format: date-time
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '429':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Korbit API key

````

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