Autorização
Chave VibeCash com permissão para esta operação.
Resposta
200 application/json
Indica se a operação foi concluída pela API.
Mensagem da operação.
Dados retornados pela operação.
Show child attributes
currencystringMoeda BRL.
availableAmountnumberSaldo disponível em reais.
pendingAmountnumberValores de entradas pendentes.
blockedAmountnumberValores reservados para operações em confirmação.
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 GET \
--url 'https://seu-dominio/v1/account/balance' \
--header 'X-API-Key: tp_live_SUA_CHAVE'{
"success": true,
"message": "Operação concluída",
"data": {
"currency": "BRL",
"availableAmount": 0,
"pendingAmount": 0,
"blockedAmount": 0,
"status": "ACTIVE",
"padrao": {
"available": 0,
"pending": 0,
"withdrawable": 0
}
},
"requestId": "req_exemplo"
}