Referência de Endpoints

Base URL por Ambiente

Ambiente	Base URL
sandbox	https://partner.equals.com.br/sandbox/api/equals-retorno
producao	https://app.equals.com.br/api/equals-retorno

---

Headers Obrigatórios

Todas as requisições para a API Equals Connect devem incluir os seguintes headers:

Header	Valor	Descrição
Authorization	Basic <base64>	Credenciais de acesso (email:token)
Content-Type	application/json	Formato do corpo da requisição

---

Remessas

Gerar Remessa

POST /retornos/geracao

Campo	Tipo	Obrigatório	Descrição
idMovFinanCfg	int	Sim	ID da configuração
dataMovimentacaoInicial	string	Sim	Data inicial dd/MM/yyyy
dataMovimentacaoFinal	string	Sim	Data final dd/MM/yyyy (máx. 30 dias)
filtroEstabelecimentos	array	Não	IDs dos estabelecimentos
filtroAdquirentes	array	Não	IDs das adquirentes

Resposta:

{ "id": 7000000001110834 }

---

Listar Configurações

GET /retornos/configuracoes

Resposta:

[
  { "id": 35176, "nome": "Remessa de Vendas" },
  { "id": 35177, "nome": "Remessa Financeira" }
]

---

Consultar Status / Listar Remessas

GET /retornos

Parâmetro	Tipo	Descrição
id	int	ID específico
dataGeracaoInicial	string	Filtro por data dd/MM/yyyy
dataGeracaoFinal	string	Filtro por data dd/MM/yyyy
situacao	string	Status específico

Resposta (Produção):

{
  "id": 7000000001110834,
  "situacao": "CONCLUIDO",
  "tipoRemessa": "Vendas - Equals (API)",
  "quantidadePaginas": 45
}

Resposta (Sandbox):

{
  "id": 4000000000476410,
  "situacao": "EM_PROCESSAMENTO",
  "tipoRemessa": "Vendas - Equals (API)",
  "quantidadePaginas": null
}

[!WARNING] Atenção (Sandbox): No ambiente de homologação, o campo situacao é fixo como EM_PROCESSAMENTO e quantidadePaginas retorna null. Os dados já estão disponíveis para download - não espere o status mudar.

---

Download de Página

POST /retornos/download

Campo	Tipo	Obrigatório	Descrição
id	int	Sim	ID da remessa
pagina	int	Sim	Número da página

Resposta:

{
  "id": 7000000001110834,
  "pagina": 1,
  "registros": {
    "registro": [...]
  }
}

---

Excluir Remessa

DELETE /retornos/{id}

Só é possível excluir remessas com status CONCLUIDO ou ERRO.