Corpo da requisição
Valor em reais, com até duas casas decimais. De R$ 5,00 a R$ 1.000,00 por operação.
coverFeebooleanPadrão true. A taxa é cobrada além do valor enviado; com false, é descontada do valor informado.
pixKeystringChave do destinatário. Obrigatória quando não há pixCopyPaste.
pixKeyTypestringCPF, CNPJ, EMAIL, TELEFONE ou ALEATORIA.
pixCopyPastestringAlternativa à chave: conteúdo completo do QR Code PIX.
descriptionstringDescrição que identifica a operaçã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.
recipientAmountnumberValor entregue ao destinatário.
totalDebitnumberTotal debitado da carteira.
createdAtstringData e hora da criação em formato ISO.
requestIdstringIdentificador da requisição.
netAmount mantém o total debitado da carteira por compatibilidade. Use recipientAmount para o valor recebido pelo destinatário e totalDebit para o custo total.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/transfer-pix/create' \
--header 'X-API-Key: tp_live_SUA_CHAVE' \
--header 'Idempotency-Key: operacao-unica-123' \
--header 'Content-Type: application/json' \
--data '{"amount":5,"coverFee":true,"pixKey":"[email protected]","pixKeyType":"EMAIL","description":"Transferência"}'{
"success": true,
"message": "Operação concluída",
"data": {
"id": "out_exemplo",
"amount": 5,
"feeAmount": 0.1,
"netAmount": 5.1,
"recipientAmount": 5,
"totalDebit": 5.1,
"status": "PROCESSING",
"createdAt": "2026-11-10T15:00:00.000Z"
},
"requestId": "req_exemplo"
}