# Criar cobrança PIX

Gere um QR Code para receber PIX.

POST`/payment-pix/create`

Try it

## Corpo da requisição

[amount](#request-amount)numberrequired

Valor em reais, com até duas casas decimais. De R$ 5,00 a R$ 1.000,00 por operação.

[description](#request-description)string

Descrição que identifica a operação.

[coverFee](#request-coverFee)boolean

Padrão false. Se true, amount é o líquido desejado e a taxa entra no valor do QR.

[customer](#request-customer)object

Opcional na SafefyPay. Na XFlow, envie name, email e document (CPF/CNPJ válido) ou configure os dados padrão.

[externalReference](#request-externalReference)string

Referência do seu sistema, até 120 caracteres. Deve ser única para o tipo da operação.

## Headers

[Idempotency-Key](#headers-Idempotency-Key)stringrequired

Identificador único de até 128 caracteres. Preserve a chave e o corpo ao repetir a operação.

## Autorização

[X-API-Key](#auth-X-API-Key)stringrequired

Chave VibeCash com permissão para esta operação.

## Resposta

201 application/json

[success](#response-success)booleanrequired

Indica se a operação foi concluída pela API.

[message](#response-message)stringrequired

Mensagem da operação.

[data](#response-data)objectrequired

Dados retornados pela operação.

Show child attributes[id](#response-data-id)string

Identificador da operação.

[status](#response-data-status)string

Situação atual do pagamento ou envio.

[amount](#response-data-amount)number

Valor bruto ou informado, em reais.

[feeAmount](#response-data-feeAmount)number

Taxa da operação, em reais.

[netAmount](#response-data-netAmount)number

Líquido da entrada ou total debitado de uma saída.

[copyPaste](#response-data-copyPaste)string

Código PIX copia e cola, quando disponível.

[qrCodeBase64](#response-data-qrCodeBase64)string | null

Imagem do QR Code, quando disponível.

[createdAt](#response-data-createdAt)string

Data e hora da criação em formato ISO.

[requestId](#response-requestId)string

Identificador da requisição.

Uma cobrança criada ainda precisa ser paga. O vencimento efetivo só aparece quando informado pelo provedor. Split, emissão fiscal e subcontas não estão habilitados nesta conexão.

## Erros

As falhas retornam o envelope com `success: false`. Consulte [erros e códigos HTTP](/docs/api-reference/guides/errors) para interpretar validação, permissão, conflito e saldo insuficiente.

## Exemplo de requisição

```bash
curl --request POST \
  --url 'https://seu-dominio/v1/payment-pix/create' \
  --header 'X-API-Key: tp_live_SUA_CHAVE' \
  --header 'Idempotency-Key: operacao-unica-123' \
  --header 'Content-Type: application/json' \
  --data '{"amount":5,"description":"Pedido 123","coverFee":false,"externalReference":"pedido-123"}'
```

## Exemplo de resposta

```json
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "id": "pay_exemplo",
    "amount": 5,
    "feeAmount": 0.1,
    "netAmount": 4.9,
    "recipientAmount": 4.9,
    "totalDebit": 0,
    "status": "PENDING",
    "createdAt": "2026-11-10T15:00:00.000Z",
    "copyPaste": "000201...CODIGO_PIX",
    "qrCodeBase64": "data:image/png;base64,..."
  },
  "requestId": "req_exemplo"
}
```
