Skip to main content
POST/payment-pix/create

Corpo da requisição

amountnumberrequired

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

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

coverFeeboolean

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

customerobject

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

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

Headers

Idempotency-Keystringrequired

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

Autorização

X-API-Keystringrequired

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

Resposta

201 application/json
successbooleanrequired

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

messagestringrequired

Mensagem da operação.

dataobjectrequired

Dados retornados pela operação.

Show child attributes
idstring

Identificador da operação.

statusstring

Situação atual do pagamento ou envio.

amountnumber

Valor bruto ou informado, em reais.

feeAmountnumber

Taxa da operação, em reais.

netAmountnumber

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

copyPastestring

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

qrCodeBase64string | null

Imagem do QR Code, quando disponível.

createdAtstring

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

requestIdstring

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 para interpretar validação, permissão, conflito e saldo insuficiente.

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"}'
{
  "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"
}

Pesquisar documentação

POST

Criar cobrança PIX

Gere um QR Code para receber PIX.

Authorization
Body
Expand 4 optional fields