Financeiro

As rotas financeiras permitem gerar uma cobrança para adicionar saldo à empresa, acompanhar o pagamento e consultar saldos e movimentações.

Rotas disponíveis

Operação	Método	Rota
Criar depósito	POST	/api/v1/valepix/deposits
Consultar depósito	GET	/api/v1/valepix/deposits/{transaction_id}
Consultar saldos	GET	/api/v1/valepix/balances
Listar transações	GET	/api/v1/valepix/transactions

Todas as rotas exigem um API token ativo e autorizado.

Fluxo recomendado

1. Crie o depósito e guarde o transaction_id.
2. Consulte o depósito até que o pagamento alcance um estado final.
3. Consulte os saldos para confirmar a disponibilidade do valor.
4. Consulte as transações para conciliação.
5. Inicie uma distribuição de benefícios.

Veja o passo a passo completo em Depositar saldo e distribuir benefícios.

Valores e uso

• Valores monetários são inteiros em centavos. Por exemplo, 50000 representa R$ 500,00.
• Guarde o transaction_id retornado na criação para acompanhar o depósito.
• Confirme o saldo disponível antes de finalizar uma distribuição.
• Use a listagem de transações para conciliar as movimentações da integração.

Envelope de resposta

Em caso de sucesso, as respostas seguem o padrão:

{
  "success": "success",
  "data": {}
}

Em erros de validação, autenticação ou autorização, consulte Erros.