> ## Documentation Index
> Fetch the complete documentation index at: https://cryptouse-d1f5ba06.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar Ordem PIX

> Crie uma nova ordem de pagamento PIX

## Criar ordem de pagamento PIX

Este endpoint gera um novo QR code de pagamento PIX para o valor especificado.

### Requisição

<ParamField body="value" type="number" required>
  O valor do pagamento em BRL
</ParamField>

<ParamField body="orderRequest" type="string">
  Referência da solicitação de ordem
</ParamField>

<ParamField body="merchant" type="string">
  Referência do comerciante
</ParamField>

<ParamField body="orderId" type="string">
  ID de ordem personalizado
</ParamField>

<ParamField body="name" type="string">
  Nome do cliente
</ParamField>

<ParamField body="cnpj" type="string">
  Número de CNPJ da empresa
</ParamField>

<ParamField body="cpf" type="string">
  Número de CPF pessoal
</ParamField>

### Exemplo de requisição

```bash theme={null}
curl -X POST "https://server.cryptouse.com.br/api/v1/order/create/pix" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu_token_aqui" \
  -d '{
    "orderRequest": "order-1753899073445",
    "merchant": "merch_456",
    "value": 200.00,
    "orderId": "ord_custom_789",
    "name": "Empresa Exemplo Ltda",
    "cnpj": "12345678901234"
  }'
```

### Resposta

<ResponseField name="message" type="string">
  Mensagem de sucesso
</ResponseField>

<ResponseField name="pixOrder" type="object">
  <Expandable title="Propriedades">
    <ResponseField name="provider" type="string">
      Provedor do pagamento
    </ResponseField>

    <ResponseField name="hash" type="string">
      Hash único da ordem
    </ResponseField>

    <ResponseField name="merchant" type="string">
      ID do comerciante
    </ResponseField>

    <ResponseField name="value" type="number">
      Valor do pagamento em BRL
    </ResponseField>

    <ResponseField name="status" type="string">
      Status da ordem

      Valores possíveis: `PENDING`, `COMPLETED`, `CANCELLED`, `FAILED`, `REFUND`
    </ResponseField>

    <ResponseField name="currency" type="string">
      Moeda do pagamento
    </ResponseField>

    <ResponseField name="universalUrl" type="string">
      URL universal do PIX
    </ResponseField>

    <ResponseField name="removedAt" type="string" nullable>
      Timestamp de remoção (se aplicável)
    </ResponseField>

    <ResponseField name="_id" type="string">
      ID interno da ordem
    </ResponseField>

    <ResponseField name="paymentLinkId" type="string">
      Identificador único do link de pagamento
    </ResponseField>

    <ResponseField name="splits" type="array">
      Array de divisões de pagamento
    </ResponseField>

    <ResponseField name="createdAt" type="string" format="date-time">
      Timestamp de criação da ordem
    </ResponseField>

    <ResponseField name="updatedAt" type="string" format="date-time">
      Timestamp de atualização da ordem
    </ResponseField>

    <ResponseField name="__v" type="number">
      Versão do documento
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="qrCode" type="string">
  Código QR do PIX para pagamento
</ResponseField>

### Exemplo de resposta

<CodeGroup>
  ```json Sucesso (200) theme={null}
  {
    "message": "order pix created",
    "pixOrder": {
      "provider": "MTBANK",
      "hash": "order-1753899073445",
      "merchant": "6884d2b4f4ea864855d89fce",
      "value": 200,
      "status": "PENDING",
      "currency": "BRL",
      "universalUrl": "00020101021226910014br.gov.bcb.pix2569qrcode.mtbank.com.br/spi/qr-code/cob/58ea8c4c14d644c2a95f4a4c2be706425204000053E",
      "removedAt": null,
      "_id": "688a68439b11ce1a1a85e450",
      "paymentLinkId": "d3d7bafe-2040-4f74-bddb-34823c6edcae",
      "splits": [],
      "createdAt": "2025-07-30T18:11:15.151Z",
      "updatedAt": "2025-07-30T18:11:15.151Z",
      "__v": 0
    },
    "qrCode": "00020101021226910014br.gov.bcb.pix2569qrcode.mtbank.com.br/spi/qr-code/cob/50ea8c4c14d644c2a95f4a4c2be706425204000053039865882BF"
  }
  ```

  ```json Requisição inválida (400) theme={null}
  {
    "message": "Dados obrigatórios ausentes para MTBank",
    "details": {
      "pixKey": "54e0c85c-55db-4e26-a32b-26b7532cddf2",
      "identifier": "order-1753899088948"
    }
  }
  ```

  ```json Requisição inválida (401) theme={null}
  {
    "message": "Unauthorized: Authorization header missing"
  }
  ```
</CodeGroup>

## O que é PIX?

PIX é o sistema de pagamentos instantâneos do Banco Central do Brasil. Ele permite transferências e pagamentos em segundos, 24 horas por dia, 7 dias por semana, incluindo feriados.

## Pagamento via PIX

Os usuários podem pagar um QR code PIX das seguintes formas:

1. Escaneando o QR code com o aplicativo do seu banco
2. Copiando e colando o código BR PIX no aplicativo do banco
3. Acessando o link de pagamento em um dispositivo móvel

## Benefícios do PIX

* **Rapidez**: Transferências confirmadas em segundos
* **Disponibilidade**: Funciona 24/7, incluindo finais de semana e feriados
* **Facilidade**: Basta escanear um QR code
* **Segurança**: Regulamentado pelo Banco Central do Brasil

## Tempo de expiração

Os QR codes PIX não expiram por padrão, mas a ordem pode ser configurada para expirar após um período específico.

## Conciliação

Quando um pagamento PIX é recebido, nosso sistema automaticamente:

1. Identifica a ordem correspondente
2. Atualiza o status para `COMPLETED`
3. Envia uma notificação para seu sistema