Referência / Introdução

Introdução

Informações básicas para integrar com a API da Elix Pay, incluindo URLs, autenticação, respostas, status HTTP, permissões e paginação.

Base URL

A URL principal informada para requisições da API v2 é:

Base URL · API v2

https://api.elixbank.com.br/v2

https://api.elixbank.com.br/v2

Os endpoints publicados nesta primeira task ainda pertencem à API v1. No console interativo, selecione a URL correspondente ao ambiente e utilize credenciais emitidas para esse mesmo ambiente.

Ambientes · API v1

Produção: https://api.elixbank.com.br/api/v1Staging:  https://staging.elixfinance.com.br/api/v1

Produção: https://api.elixbank.com.br/api/v1Staging:  https://staging.elixfinance.com.br/api/v1

Autenticação

Todas as requisições desta referência devem incluir o header Authorization utilizando autenticação Basic.

Concatene a API Key e o Secret com dois-pontos e codifique o valor em Base64:

HTTP Header

SUA_API_KEY:SEU_SECRET
Authorization: Basic BASE64(SUA_API_KEY:SEU_SECRET)

SUA_API_KEY:SEU_SECRET
Authorization: Basic BASE64(SUA_API_KEY:SEU_SECRET)

Credenciais ausentes ou inválidas retornam 401 Unauthorized. Consulte o guia de autenticação para criar e gerenciar suas credenciais.

Formato das respostas

As respostas utilizam JSON e seguem uma estrutura padronizada. Verifique sempre o campo success antes de acessar data.

Resposta de sucesso

JSON

{  "data": { ... },  "success": true,  "error": null}

{  "data": { ... },  "success": true,  "error": null}

Resposta de erro

JSON

{  "data": null,  "success": false,  "error": "Mensagem descritiva do erro"}

{  "data": null,  "success": false,  "error": "Mensagem descritiva do erro"}

Códigos de status HTTP

200

Requisição realizada com sucesso.

400

Requisição inválida. Verifique os dados enviados.

401

Não autenticado. As credenciais estão ausentes, inválidas ou foram revogadas.

403

As credenciais não possuem permissão para acessar o recurso solicitado.

404

Recurso não encontrado.

422

Os dados possuem formato válido, porém falharam na validação semântica.

429

Limite de requisições excedido.

5xx

Erro interno da plataforma. Repita a chamada utilizando backoff exponencial.

Permissões

Cada credencial pode possuir permissões granulares. Uma resposta 403 Forbidden indica que a chave foi reconhecida, mas não possui acesso ao recurso solicitado.

Consulte o guia de segurança para entender escopos e solicitar permissões adicionais.

Paginação

Atualmente, os endpoints de listagem retornam todos os registros disponíveis. Quando a paginação for adicionada, utilizará os parâmetros:

limit

Quantidade máxima de registros retornados.

offset

Quantidade de registros ignorados antes do início da página.