Informações da Conta

Esta seção descreve como obter informações detalhadas sobre uma conta específica, incluindo dados do usuário, saldo e provedores configurados.

Visão Geral

O endpoint de informações da conta retorna dados completos sobre uma conta, incluindo:

• Dados do usuário (nome, nível de acesso, status)
• Saldo disponível
• Provedores configurados (PIX, etc.)
• Estatísticas de cobranças e transações

Endpoint

GET /account/{account_id}/info

Retorna as informações detalhadas de uma conta específica.

URL Completa:

https://app.finexis.com.br/api/v1/gateway/account/{account_id}/info

Headers:

Authorization: Bearer {token}

Parâmetros da URL:

• account_id (obrigatório): ID da conta que você deseja consultar

Exemplo de Requisição:

curl -X GET \
  'https://app.finexis.com.br/api/v1/gateway/account/5/info' \
  -H 'Authorization: Bearer {seu_token}'

Resposta de Sucesso (200):

{
  "status": "success",
  "message": "Account information retrieved successfully",
  "data": {
    "id": 5,
    "name": "JOAO",
    "access_level": null,
    "is_blocked": false,
    "balance": null,
    "providers": [
      {
        "id": 2,
        "type": "pix",
        "charges": 30,
        "transactions": 20
      }
    ]
  }
}

Campos da Resposta

Campo	Tipo	Descrição
id	integer	ID único da conta
name	string	Nome do usuário da conta
access_level	string/null	Nível de acesso do usuário
is_blocked	boolean	Indica se a conta está bloqueada
balance	number/null	Saldo atual da conta
providers	array	Lista de provedores configurados

Estrutura do Provider

Campo	Tipo	Descrição
id	integer	ID do provedor
type	string	Tipo do provedor (ex: "pix")
charges	integer	Número total de cobranças
transactions	integer	Número total de transações

Casos de Uso

Este endpoint é útil para:

• Verificar o status da conta antes de realizar operações
• Consultar o saldo disponível
• Verificar quais provedores estão configurados
• Obter estatísticas de uso (cobranças e transações)

Próximos Passos

• Consulte as Taxas da Conta para entender os custos
• Comece a criar Cobranças PIX
• Realize Transferências PIX