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

# Gerar transação PIX

> Crie uma cobrança Pix (Cash In) e receba o QR Code para pagamento

<Info>
  Essa rota utiliza os certificados e o Bearer Token de **Cash In**.
</Info>

## Certificados

Esta rota usa autenticação mútua (mTLS). Envie o certificado de **Cash In**, a chave e a senha na requisição:

<ParamField path="--cert" type="file" required>
  Certificado de Cash In do cliente (`client.crt`).
</ParamField>

<ParamField path="--key" type="file" required>
  Chave privada do cliente (`client.key`).
</ParamField>

<ParamField path="--pass" type="string" required>
  Senha para descriptografar a chave `.key`, enviada por e-mail junto com os certificados.
</ParamField>

## Headers

<ParamField header="Content-Type" type="string" required>
  Formato do corpo da requisição. Use `application/json`.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Bearer Token de Cash In. Formato: `Bearer {access_token}`.
</ParamField>

## Body

<ParamField body="calendario.expiracao" type="integer" required>
  Tempo em segundos para a cobrança expirar.
</ParamField>

<ParamField body="devedor.cpf" type="string">
  CPF do cliente.
</ParamField>

<ParamField body="devedor.nome" type="string">
  Nome do cliente.
</ParamField>

<ParamField body="valor.original" type="string" required>
  Valor da cobrança em reais. Exemplo: `"50.00"`.
</ParamField>

<ParamField body="chave" type="string" required>
  Chave Pix cadastrada na conta. É retornada ao gerar as credenciais de Cash In.
</ParamField>

<ParamField body="solicitacaoPagador" type="string">
  Descrição do pagamento. Fica visível para o cliente.
</ParamField>

<ParamField body="infoAdicionais" type="array">
  Informações internas opcionais, no formato `{ "nome": "...", "valor": "..." }`.
</ParamField>

## Resposta

<ResponseField name="txid" type="string">
  Identificador único da cobrança.
</ResponseField>

<ResponseField name="status" type="string">
  Status da cobrança. Ao criar, retorna `ATIVA`.
</ResponseField>

<ResponseField name="calendario" type="object">
  Datas da cobrança.

  <Expandable title="calendario">
    <ResponseField name="calendario.criacao" type="string">
      Data e hora de criação (ISO 8601).
    </ResponseField>

    <ResponseField name="calendario.expiracao" type="integer">
      Tempo de expiração, em segundos.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="loc" type="object">
  Dados da location do QR Code (`id`, `location`, `tipoCob`).
</ResponseField>

<ResponseField name="location" type="string">
  URL da location usada para renderizar o QR Code.
</ResponseField>

<ResponseField name="valor" type="object">
  Valor da cobrança (`original`).
</ResponseField>

<ResponseField name="chave" type="string">
  Chave Pix que recebe o pagamento.
</ResponseField>

<ResponseField name="pixCopiaECola" type="string">
  Código Pix copia e cola que o cliente usa para pagar.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST "https://api.pix.basspago.com.br/cob" \
    --cert ./client.crt \
    --key ./client.key \
    --pass "SUA_SENHA_DO_CERTIFICADO" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer {access_token}" \
    -d '{
      "calendario": {
        "expiracao": 3600
      },
      "devedor": {
        "cpf": "11144477735",
        "nome": "Maria Oliveira"
      },
      "valor": {
        "original": "49.90"
      },
      "chave": "e3b0c442-98fc-4c1a-b2d6-9a7f5e10c3d4",
      "solicitacaoPagador": "Pagamento do pedido #90210"
    }'
  ```

  ```php PHP theme={null}
  <?php

  $ch = curl_init('https://api.pix.basspago.com.br/cob');

  curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_POST => true,
      CURLOPT_SSLCERT => './client.crt',
      CURLOPT_SSLKEY => './client.key',
      CURLOPT_KEYPASSWD => 'SUA_SENHA_DO_CERTIFICADO',
      CURLOPT_HTTPHEADER => [
          'Content-Type: application/json',
          'Authorization: Bearer {access_token}',
      ],
      CURLOPT_POSTFIELDS => json_encode([
          'calendario' => ['expiracao' => 3600],
          'devedor' => ['cpf' => '11144477735', 'nome' => 'Maria Oliveira'],
          'valor' => ['original' => '49.90'],
          'chave' => 'e3b0c442-98fc-4c1a-b2d6-9a7f5e10c3d4',
          'solicitacaoPagador' => 'Pagamento do pedido #90210',
      ]),
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  echo $response;
  ```

  ```javascript Node.js theme={null}
  import fs from "node:fs";
  import https from "node:https";
  import axios from "axios";

  const agent = new https.Agent({
    cert: fs.readFileSync("./client.crt"),
    key: fs.readFileSync("./client.key"),
    passphrase: "SUA_SENHA_DO_CERTIFICADO",
  });

  const { data } = await axios.post(
    "https://api.pix.basspago.com.br/cob",
    {
      calendario: { expiracao: 3600 },
      devedor: { cpf: "11144477735", nome: "Maria Oliveira" },
      valor: { original: "49.90" },
      chave: "e3b0c442-98fc-4c1a-b2d6-9a7f5e10c3d4",
      solicitacaoPagador: "Pagamento do pedido #90210",
    },
    {
      httpsAgent: agent,
      headers: { Authorization: "Bearer {access_token}" },
    }
  );

  console.log(data);
  ```
</RequestExample>

<ResponseExample>
  ```json 201 - Criada theme={null}
  {
    "calendario": {
      "criacao": "2026-07-21T13:05:12.000Z",
      "expiracao": 3600
    },
    "txid": "a1b2c3d4e5f60718293a4b5c6d7e8f90",
    "revisao": 0,
    "loc": {
      "id": 4821,
      "location": "pix.basspago.com/qr/v2/9f8e7d6c5b4a",
      "tipoCob": "cob"
    },
    "location": "pix.basspago.com/qr/v2/9f8e7d6c5b4a",
    "status": "ATIVA",
    "devedor": {
      "cpf": "11144477735",
      "nome": "Maria Oliveira"
    },
    "valor": {
      "original": "49.90"
    },
    "chave": "e3b0c442-98fc-4c1a-b2d6-9a7f5e10c3d4",
    "solicitacaoPagador": "Pagamento do pedido #90210",
    "infoAdicionais": [
      {
        "nome": "Pedido",
        "valor": "90210"
      }
    ],
    "pixCopiaECola": "00020126580014br.gov.bcb.pix..."
  }
  ```
</ResponseExample>
