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

# Criar cobrança PIX

> Cria uma nova cobrança PIX imediata com QR Code e código PIX Copia e Cola



## OpenAPI

````yaml POST /api/pix
openapi: 3.1.0
info:
  title: Mycredit API
  description: API para integração com serviços PIX e gestão de contas Mycredit
  version: 1.0.0
  contact:
    name: Suporte Mycredit
    url: https://mycredit.com.br/contato
servers:
  - url: https://sandboxapi.mycredit.com.br
    description: Ambiente de sandbox
  - url: https://api.mycredit.com.br
    description: Ambiente de produção
security:
  - bearerAuth: []
paths:
  /api/pix:
    post:
      summary: Criar cobrança PIX
      description: >-
        Cria uma nova cobrança PIX imediata com QR Code e código PIX Copia e
        Cola
      operationId: createPixCharge
      requestBody:
        description: Dados da cobrança PIX imediata
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePixChargeRequest'
      responses:
        '200':
          description: Cobrança PIX criada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixChargeResponse'
        '400':
          description: Erro de validação nos dados enviados
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Não autorizado - token inválido ou expirado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    CreatePixChargeRequest:
      type: object
      required:
        - formaPagamento
      properties:
        formaPagamento:
          type: object
          description: Configurações da forma de pagamento
          required:
            - TpTransacao
            - IdFaturaPag
            - ModPagamento
            - QtdParcelas
            - ValorPagamento
          properties:
            tpTransacao:
              type: integer
              description: Tipo de transação (11 para PIX)
              example: 11
            idFaturaPag:
              type: string
              description: >-
                Identificador da fatura de pagamento (UUID) gerado por sua
                aplicação para identificar a cobrança PIX em nossa plataforma.
                **Este é o identificador que você utilizará na consulta do
                status da cobrança.**
              example: 9b041599-eacc-4a0f-9a16-e0191c9a66AA
            modPagamento:
              type: integer
              description: Modalidade de pagamento (18 para PIX)
              example: 18
            qtdParcelas:
              type: integer
              description: Quantidade de parcelas (1 para PIX)
              example: 1
            valorPagamento:
              type: number
              description: Valor do pagamento em reais
              example: 1.29
              minimum: 0.01
        cliente:
          type: object
          description: Dados do cliente
          required:
            - xNome
            - documento
          properties:
            xNome:
              type: string
              description: Nome completo do cliente
              example: Nome do pagador
            documento:
              type: string
              description: CPF/CNPJ do cliente
              example: '99999999999'
    PixChargeResponse:
      type: object
      properties:
        sucesso:
          type: boolean
          description: Indica se a operação foi executada com sucesso
          example: true
        data:
          type: object
          description: Dados da cobrança PIX criada
          properties:
            retTexto:
              type: string
              description: Mensagem de retorno da operação
              example: Inserido com sucesso.
            retUrl:
              type: string
              description: Payload BR Code para pagamento PIX (código PIX Copia e Cola)
              example: >-
                00020101021226990014br.gov.bcb.pix2577pix.bpp.com.br/23114447/qrs2/v2/02bQN4pZi9ZfA841zm0obUq0xDJ4kK5kebEiF8e2iGr1G52040000530398654041.005802BR5924SATURNIA
                TECNOLOGIA LTDA6009SAO PAUL062070503***63044F29
            transacaoId:
              type: string
              description: Identificador único da transação PIX
              example: 9f8b4c46-82cd-4388-52b4-08dddfd74ba1
            expira:
              type: string
              format: date-time
              description: Data e hora de expiração do QR Code PIX
              example: '2025-08-20T11:29:24.4187003Z'
    ErrorResponse:
      type: object
      properties:
        sucesso:
          type: boolean
          description: >-
            Indica se a operação foi executada ou concluída com sucesso. Sempre
            false para respostas de erro
          example: false
        errors:
          type: string
          description: Descrição detalhada do erro ocorrido
          example: Mensagem de erro
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````