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

# Criar cobrança PIX

> Cria uma cobrança PIX

O valor é informado em reais. A resposta contém `id`, status e os dados do QR Code.

## Autenticação

Todas as rotas exigem o header `X-API-Key`. A chave deve começar com `zeriq_`.

```http theme={null}
X-API-Key: zeriq_sua_chave
```

```bash cURL theme={null}
curl -X POST "https://api.zeriqpay.com.br/v1/payments/create" \
  -H "X-API-Key: zeriq_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{"amount":25.50,"description":"Pedido #123","expirationSeconds":1800}'
```

### Escopo necessário

`transactions.create`

`amount` aceita no máximo duas casas decimais. `expirationSeconds` deve estar entre 60 e 604800.

## Referência

* **Método:** `POST`
* **Rota:** `/v1/payments/create`
* **Autenticação:** `X-API-Key`

A referência interativa desta operação é gerada a partir do arquivo OpenAPI da ZeriqPay.

## Guia de integração

1. Envie a requisição para `https://api.zeriqpay.com.br/v1/payments/create` usando o método `POST`.
2. Inclua `X-API-Key` e conceda à chave o escopo `transactions.create`.
3. Trate `success: true` como sucesso e leia o resultado dentro de `data`.
4. Em erros `4xx`, preserve `message` e o status HTTP para diagnóstico e retry controlado.

### Referência rápida

* **Autenticação:** `X-API-Key: zeriq_sua_chave`
* **Content-Type:** `application/json` quando houver body
* **Base URL:** `https://api.zeriqpay.com.br`
* **Contrato:** consulte o bloco OpenAPI interativo desta página para visualizar parâmetros, schemas e exemplos de resposta.


## OpenAPI

````yaml POST /v1/payments/create
openapi: 3.1.0
info:
  title: ZeriqPay API
  description: >-
    Referência da API v1 da ZeriqPay. As rotas de gerenciamento de webhooks não
    fazem parte desta documentação.
  version: 1.0.0
  contact:
    name: ZeriqPay
    url: https://api.zeriqpay.com.br
servers:
  - url: https://api.zeriqpay.com.br
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Conta
    description: Dados, taxas e limites da conta
  - name: Pagamentos PIX
    description: Cobranças PIX
  - name: Transações
    description: Consulta de transações
  - name: Transferências
    description: Saídas PIX, cripto e internas
  - name: Reembolsos
    description: Reembolsos de cobranças
  - name: Disputas MED
    description: Consulta e envio de evidências MED
  - name: Webhooks
    description: Cadastro e configuração dos endpoints de webhook
paths:
  /v1/payments/create:
    post:
      tags:
        - Pagamentos PIX
      summary: Criar cobrança PIX
      description: >-
        Cria uma cobrança PIX e retorna os dados necessários para o pagamento.
        `amount` é informado em reais.


        **Escopo necessário:** `transactions.create`.
      operationId: createPixPayment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentRequest'
            example:
              amount: 25.5
              description: 'Pedido #123'
              coverFee: false
              expirationSeconds: 1800
              payerName: Cliente Exemplo
              payerDocument: '12345678909'
      responses:
        '200':
          description: Operação concluída com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                success: true
                message: Transação criada com sucesso
                data:
                  id: cmtransaction
                  amount: 25.5
                  status: PENDING
                  copyPaste: 000201...
                  qrCodeBase64: data:image/png;base64,...
                  qrcodeUrl: https://...
        '400':
          description: Dados inválidos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '401':
          description: API Key ausente ou inválida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '403':
          description: Conta bloqueada ou escopo insuficiente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '429':
          description: Limite específico da rota excedido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    CreatePaymentRequest:
      type: object
      required:
        - amount
      properties:
        amount:
          type: number
          minimum: 0.01
          multipleOf: 0.01
        description:
          type: string
          minLength: 3
          maxLength: 180
        coverFee:
          type: boolean
        expirationSeconds:
          type: integer
          minimum: 60
          maximum: 604800
        payerName:
          type: string
          maxLength: 120
        payerDocument:
          type: string
          maxLength: 14
    GenericResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          additionalProperties: true
      required:
        - success
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key ZeriqPay iniciada por `zeriq_`.

````

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