A API da VibeCash reúne cobranças PIX, envios, devoluções, transferências internas, carteira, programações e webhooks em uma única integração.
Base URL
https://seu-dominio/v1Autenticação (API key)
Crie a credencial em Integrações → API no painel. Para cada chamada, envie os headers abaixo.
X-API-Key: tp_live_SUA_CHAVE
Content-Type: application/jsonO servidor também aceita o formato Bearer para a chave VibeCash. Credencial inválida retorna 401; ausência de permissão retorna 403.
Envelope de resposta
Uma resposta de sucesso traz os dados da operação em data.
{
"success": true,
"message": "Operação concluída",
"data": {},
"requestId": "req_exemplo"
}Em uma falha, verifique o código HTTP e os campos de error.
{
"success": false,
"message": "Não foi possível concluir a operação.",
"error": {
"code": "REQUEST_ERROR",
"statusCode": 400
},
"requestId": "req_exemplo"
}5 significa R$ 5,00.Campos na resposta
Operações financeiras retornam o ID, valor, taxa, situação e datas. Os campos PIX aparecem quando disponíveis. Uma referência externa permite relacionar o pagamento com um pedido do seu sistema.
Rate limiting
O limite é de 100 chamadas por minuto por chave. Ao receber HTTP 429, reduza a frequência e aguarde antes de repetir. Veja os limites de uso. Para diagnosticar outras falhas, consulte erros e códigos HTTP.