Saldo da empresa | Referência da API Elix Pay

Query parameters

1 campo

user_id

integerOpcional

ID do usuário alvo. Parâmetro restrito a credenciais SUPERUSER ou DIRECTOR.

Resposta

200AccountBalanceResponseDTOV2

Saldo, limites e valores agregados retornados para a conta.

JSON · Resposta de sucesso

{  "data": {    "amount_invested": 0,    "amount_investment_total": 0,    "amount": 150000,    "success": true,    "code": 200,    "amount_points": 30.5,    "amount_schedules": 0,    "limit_for_myself": 0,    "daily_night_limit": 0,    "daily_morning_limit": 0,    "limit_available": 0,    "limit_of_weekend": 0  },  "success": true,  "error": null}

{  "data": {    "amount_invested": 0,    "amount_investment_total": 0,    "amount": 150000,    "success": true,    "code": 200,    "amount_points": 30.5,    "amount_schedules": 0,    "limit_for_myself": 0,    "daily_night_limit": 0,    "daily_morning_limit": 0,    "limit_available": 0,    "limit_of_weekend": 0  },  "success": true,  "error": null}

Campos da resposta

14 campos

amount_invested

numberObrigatório

Valor atualmente investido.

amount_investment_total

numberObrigatório

Valor total dos investimentos.

amount

numberObrigatório

Saldo disponível da conta.

success

booleanObrigatório

Indica se a consulta foi concluída.

message

stringOpcional

Mensagem complementar da resposta.

code

integerObrigatório

Código interno retornado pela operação.

individual_id

stringOpcional

Identificador individual da conta.

amount_points

numberOpcional

Saldo de pontos.

Padrão: 30.5

amount_schedules

numberOpcional

Valor de agendamentos.

Padrão: 0

limit_for_myself

numberOpcional

Limite para a própria conta.

Padrão: 0

daily_night_limit

numberOpcional

Limite diário noturno.

Padrão: 0

daily_morning_limit

numberOpcional

Limite diário diurno.

Padrão: 0

limit_available

numberOpcional

Limite disponível.

limit_of_weekend

numberOpcional

Limite de fim de semana.

Padrão: 0

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.