Detalhes da empresa | Referência da API Elix Pay

Resposta

200Detalhes da empresa

Dados cadastrais da conta autenticada e da empresa vinculada.

JSON · Resposta de sucesso

{  "data": {    "is_active": true,    "created_at": "2026-07-01T12:00:00Z",    "updated_at": "2026-07-01T12:00:00Z",    "id": 123,    "username": "empresa.exemplo",    "email": "integracao@empresa.com.br",    "corporate_reason": "Empresa Exemplo LTDA",    "fantasy_name": "Empresa Exemplo",    "account_number": "000123",    "cnpj": "00000000000100"  },  "success": true,  "error": null}

{  "data": {    "is_active": true,    "created_at": "2026-07-01T12:00:00Z",    "updated_at": "2026-07-01T12:00:00Z",    "id": 123,    "username": "empresa.exemplo",    "email": "integracao@empresa.com.br",    "corporate_reason": "Empresa Exemplo LTDA",    "fantasy_name": "Empresa Exemplo",    "account_number": "000123",    "cnpj": "00000000000100"  },  "success": true,  "error": null}

Campos sem informação cadastrada podem ser retornados como nulos.

Campos da resposta

16 campos

idintegerObrigatório

Identificador da conta autenticada.

usernamestringObrigatório

Nome de usuário da conta.

emailstringObrigatório

E-mail principal cadastrado.

is_activebooleanObrigatório

Indica se a conta está ativa.

account_numberstringOpcional

Número da conta vinculada à empresa.

cpfstringOpcional

CPF cadastrado, quando aplicável.

cnpjstringOpcional

CNPJ cadastrado, quando aplicável.

corporate_reasonstringOpcional

Razão social da empresa.

fantasy_namestringOpcional

Nome fantasia da empresa.

full_namestringOpcional

Nome completo do titular da conta.

phonestringOpcional

Telefone principal cadastrado.

countrystringOpcional

País associado ao cadastro.

addressobjectOpcional

Endereço principal cadastrado.

company_detailsobjectOpcional

Informações complementares da empresa.

created_atstring · date-timeObrigatório

Data de criação da conta.

updated_atstring · date-timeOpcional

Data da atualização mais recente.

Status HTTP

200

Detalhes retornados 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.