Corpo da requisição
Valor em reais, com até duas casas decimais. De R$ 5,00 a R$ 1.000,00 por operação.
descriptionstringDescrição que identifica a operação.
coverFeebooleanPadrão false. Se true, amount é o líquido desejado e a taxa entra no valor do QR.
customerobjectOpcional na SafefyPay. Na XFlow, envie name, email e document (CPF/CNPJ válido) ou configure os dados padrão.
externalReferencestringReferência do seu sistema, até 120 caracteres. Deve ser única para o tipo da operação.
Headers
Identificador único de até 128 caracteres. Preserve a chave e o corpo ao repetir a operação.
Autorização
Chave VibeCash com permissão para esta operação.
Resposta
Indica se a operação foi concluída pela API.
Mensagem da operação.
Dados retornados pela operação.
Show child attributes
idstringIdentificador da operação.
statusstringSituação atual do pagamento ou envio.
amountnumberValor bruto ou informado, em reais.
feeAmountnumberTaxa da operação, em reais.
netAmountnumberLíquido da entrada ou total debitado de uma saída.
copyPastestringCódigo PIX copia e cola, quando disponível.
qrCodeBase64string | nullImagem do QR Code, quando disponível.
createdAtstringData e hora da criação em formato ISO.
requestIdstringIdentificador da requisiçã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"
}