Saldo da empresa | Referência da API Elix Pay

Resposta

200Saldo da empresa

Valores consolidados da conta vinculada à credencial utilizada.

JSON · Resposta de sucesso

{  "data": {    "amount_invested": 0,    "amount_investment_total": 0,    "amount": 150000,    "success": true,    "amount_schedules": 0,    "limit_available": 0  },  "success": true,  "error": null}

{  "data": {    "amount_invested": 0,    "amount_investment_total": 0,    "amount": 150000,    "success": true,    "amount_schedules": 0,    "limit_available": 0  },  "success": true,  "error": null}

Campos da resposta

7 campos

amountnumberObrigatório

Saldo disponível da conta.

amount_investednumberOpcional

Valor atualmente destinado a investimentos.

amount_investment_totalnumberOpcional

Valor total registrado em investimentos.

amount_schedulesnumberOpcional

Valor reservado para operações agendadas.

limit_availablenumberOpcional

Limite disponível para uso.

successbooleanObrigatório

Confirma o sucesso da consulta.

messagestringOpcional

Mensagem complementar da consulta.

Status HTTP

200

Saldo retornado com sucesso.

401

Credenciais ausentes, inválidas ou revogadas.

403

A credencial não possui permissão para acessar o recurso.

422

Erro de validação nos dados enviados.

429

Limite de requisições excedido.

5xx

Erro interno da plataforma.