Buscar na documentação

Módulos

Authentication

Merchant

Catalog

Order

Events

Logistics

Shipping

Review

Financial

Soluções

API Reconciliation On Demand

A API Reconciliation On Demand traz melhorias significativas no processo de geração e atualização dos dados de reconciliação:Os arquivos de reconciliação agora são gerados de forma assíncrona mediante solicitação do parceiro, proporcionando maior flexibilidade e eficiência no processo.O período de atualização do arquivo foi otimizado: enquanto na versão anterior a atualização ocorria apenas após o fechamento do período de apuração, agora as atualizações são realizadas diariamente, incrementando ao arquivo sempre os lançamentos financeiros processados no dia anterior. Ou seja, pode-se buscar arquivos de competências (mês e ano) anteriores , ou buscar a competência do mês atual, na qual o arquivo retornará todas as informações até D-1.

Formato do arquivo

O arquivo de conciliação é disponibilizado no formato CSV compactado (.gz), com delimitador ";" e pode ser baixado através de um link retornado pela API de Conciliação Sob Demanda.Este link tem tempo de expiração e um novo link é gerado a cada consulta. A API retorna também totalizadores de pedidos e linhas para auxiliar na validação do conteúdo do arquivo.Os lançamentos financeiros são agrupados em arquivos individuais por competência (mês e ano).

Frequência de atualização

O arquivo mensal existente é atualizado diariamente, incrementando os lançamentos financeiros gerados no dia anterior.É importante considerar que com a nova periodicidade de atualização, o campo valor_transacao será atualizado diariamente enquanto o período de apuração estiver aberto, refletindo os valores acumulados até a data atual. Quando o período de apuração for fechado, este campo apresentará o valor final consolidado.

Produtos de apuração semanal: App iFood

O período de apuração compreende de segunda-feira à domingo e a apuração ocorre na segunda-feira seguinte ao término do período. Exemplo:

Período de apuração: 04/08/2025 à 10/08/2025 (segunda-feira à domingo)
Apuração: 11/08/2025 (segunda-feira)
Todas os campos referentes a esse período de apuração deverão estar preenchidos na terça-feira, 12/08

Produtos de apuração diária: Maquinona, Totem, Saipos, Anota AI

O período de apuração é composto por um dia, ou seja, a cada dia terá uma nova apuração. Exemplo:

Período de apuração: 04/08/2024
Apuração: 05/08/2024
Todas os campos referentes a esse período de apuração deverão estar preenchidos na terça-feira, 06/08

Nota
Ao solicitar a geração de um arquivo para um período específico de apuração, só é possível gerar um novo arquivo para o mesmo período após 6 horas. No entanto, durante esse período, você poderá consultar o arquivo já gerado utilizando o requestId fornecido na resposta da solicitação inicial.
Exemplo:
Uma solicitação foi enviada para o período de agosto/2025 no dia 4 de setembro às 12h e o sistema retornou o requestId ffdec983-6094-4816-829b-9970ac5dab21. Você conseguirá usar este ID para consultar o arquivo assim que ele estiver disponível. Porém, só será possível fazer uma nova solicitação para o mesmo período após 6 horas, ou seja, após 18h.
Importante:
Caso seja feita uma nova solicitação para o mesmo período dentro do intervalo de 6 horas, o sistema retornará o erro 409 - Conflito, porém devolvendo o ultimo id que pode ser utilizado para consultar a ultima solicitação.

Parâmetros de busca

A API é chamada utilizando as seguintes informações:

Path Parameter

merchantId (obrigatório) - Identificador único da loja

Request Body

competencia (obrigatório) - Competência do arquivo no formato AAAA-MM

Campos do arquivo

É importante considerar que alguns campos que estavam na versão anterior do arquivo logo serão descontinuados, pois já não fazem mais sentido dentro do ecossistema de produtos do iFood, sendo eles:

data_fato_gerador
loja_id_externo
titulo - novo campo id_saldo tem a mesma função
pedido_associado_externo
valor_cesta_inicial

Por enquanto, sertão mantidos com o preenchimento “Coluna descontinuada”, a fim de dar tempo para que os parceiros se adaptem da forma como for necessária.

Impacto no repasse

O campo 'impacto_no_repasse' segrega os lançamentos financeiros em dois principais grupos nos relatórios de conciliação financeira do iFood: com impacto no repasse e sem impacto no repasse.Para chegar no valor líquido que a loja tem a receber do iFood referente ao período de apuração analisado, ou ao pedido analisado, deve-se considerar apenas os lançamentos financeiros com impacto no repasse.Os lançamentos sem impacto no repasse são exibidos no relatório apenas com finalidade informativa para as lojas, para que saibam da existência desses eventos financeiros que não impactam positiva ou negativamente o montante a ser repassado para a loja parceira.Exemplos de lançamentos financeiros que não têm impacto no repasse: entrada financeira de pedidos em que o recebedor do pagamento é a loja parceira (como pedidos com método de pagamento meal voucher) e promoções incentivadas pela loja.

Categorização dos lançamentos financeiros

Há três campos que indicam ao que se referem os lançamentos financeiros de débito e crédito contidos no período, são eles:

Campo 'fato_gerador': indica qual o fato/ação (venda, cancelamento total ou parcial, ressarcimento, ocorrências, etc.) que ocorreu durante o fluxo de vida do pedido e gerou aquele lançamento financeiro. Há fatos geradores que não possuem pedidos associados à eles, como por exemplo
Campo 'tipo_lancamento': é uma categorização/agrupamento dos lançamentos financeiros de acordo com sua natureza.
Campo 'descricao_lancamento': descrição detalhada do que se trata o lançamento financeiro.

Tabela Fato Gerador: O que gerou aquele lançamento financeiro

Fato Gerador	Descrição
Venda	Informações sobre a venda efetiva do pedido, valor pago pelo pedido, subsídios, taxas, e demais créditos e débitos atrelados à venda
Cancelamento Total	Informações sobre o cancelamento do pedido, valor e motivo de cancelamento
Cancelamento Parcial	Informações sobre o cancelamento do item
Processamento Manual	Quando há uma falha sistêmica e precisamos realizar um processamento manual para incluir os registros que ficaram pendentes
Ressarcimento/Indenização	Informações sobre um pedido que sofreu cancelamento, e foi ressarcido
Ocorrência Venda	Toda ocorrência gerada associada à um pedido, podendo ser ocorrência de crédito ou de débito
Solicitação frete	Informações sobre uma solicitação do serviço de entrega iFood
Cancelamento Solicitação frete	Informações sobre o cancelamento da solicitação do serviço de entrega iFood
Ocorrência Avulsa	Ocorrência de débito ou crédito, não necessariamente associada à um pedido
Fechamento	Informação do fechamento contábil, restituição do imposto de renda
Carregamento de Saldo Devedor	Saldo que a loja deve para o iFood, referente a cobranças de serviço (como por exemplo comissão de pedidos, frete e etc.), quando não foi possível realizar o débito via repasse

Tabela Tipo Lançamento: Categorização dos lançamentos financeiros

Tipo de Lançamento	Descrição
Retenção	Valor que é retido pelo iFood do montante de entrada financeira, ou seja, não é repassado à loja parceira
Subsídio	Uma promoção aplicada ao pedido, pode ser iFood ou Loja
Entrada Financeira	Informação relacionada à uma venda, pois trata-se da entrada financeira, ou seja, o valor pago pelo cliente
Reembolso	Reembolso realizado pelo iFood
Ajuste Pontual	Ajustes realizados para correção de uma cobrança ou crédito indevido
Ressarcimento	Ressarcimento sobre um pedido que sofreu cancelamento
Cobrança	Uma cobrança que o iFood realiza para a loja parceira, por exemplo, cobrança de comissão iFood
Ocorrência	Ocorrência de débito ou crédito gerada por um processo manual, para fazer um crédito ou cobrança devida
Estorno	Devolução de um valor que anteriormente havia sido debitado ou creditado da loja
Crédito	Valor positivo repassado à loja
Restituição	Informação do fechamento contábil, restituição do imposto de renda

Descrição do Lançamento: descrição detalhada do lançamento financeiro

Valor dos lançamentos financeiros

O campo 'valor' concentra todos os valores dos lançamentos financeiros que são necessários para realizar a conciliação.Os valores se encontram com os sinais adequados de positivo e negativo, para indicar quais lançamentos financeiros representam créditos ou débitos.O valor da entrada financeira (valor pago pelo cliente) é representado como positivo, e é o valor de referência inicial de um pedido, a partir dele que somamos e subtraímos todos os outros lançamentos financeiros (de crédito e débito) e que portanto, o repasse do pedido é calculado. Exceto pela entrada financeira que é o valor base da venda, todos os outros lançamentos com sinal positivo representam créditos.Os lançamentos que estiverem com sinal negativo podem representar uma cobrança ou retenção.Importante: Para chegar no valor líquido que a loja tem a receber do iFood referente ao período de apuração analisado, ou ao pedido analisado, deve-se considerar apenas o 'valor' dos lançamentos financeiros com impacto no repasse.Os demais campos monetários do arquivo são apenas dados informativos e complementares, não sendo necessário considerá-los para compor o valor a ser recebido pela loja.

Pedido associado iFood

Ao consultar um pedido pelo seu identificador único no campo 'pedido_associado_ifood', é possível identificar todos os lançamentos financeiros vinculados àquele pedido, dentro do período de apuração à qual se refere o arquivo.Há lançamentos financeiros que não são vinculados a nenhum pedido. Para estes casos, o campo 'pedido_associado_ifood' não é preenchido. Podemos citar como exemplo alguma ocorrência de débito ou crédito realizada para a loja parceira que não é referente a nenhum pedido e eventuais cobranças de mensalidade.

Valor da transação

O valor correspondente a cada repasse é informado no campo 'valor_transação', que só será preenchido no arquivo após o fechamento do período de apuração, enquanto o período estiver em aberto, será preenchido com a mensagem “Período de apuração em aberto“

Data esperada de repasse

O campo 'data_repasse_esperada' indica a data programada para que a loja receba o repasse do iFood, caso não haja nenhuma falha no processo de liquidação dos títulos, esse campo também estará disponível no arquivo após o fechamento do período de apuração.O valor total previsto a ser repassado à loja em uma data específica é calculado somando-se o 'valor_transação' de todos os repasses com essa mesma data de repasse programada.

ID do saldo

O saldo é conjunto de lançamentos financeiros que darão origem aos repasses. Um saldo negativo indica que a loja teve mais gastos (cancelamentos, débitos) do que receitas (vendas, créditos) naquele período, esse valor pode ser compensado em repasses futuros ou cobrado via boleto.Um repasse pode ser composto por um ou mais saldos, incluindo saldos negativos carregados do passado que venham a ser compensados com os novos saldos positivos.Chave de ligação direta com a API Settlements.

Canal de vendas

O campo 'canal_vendas' representa pelo qual o pedido entra na plataforma (novos canais podem ser adicionados), alguns canais de vendas são:

canal_de_vendas
iFood
Maquinona
Antecipação
White Label
Anota AI
Shop
Totem

Descrição de todos os campos

Nota: todas as datas serão enviadas no padrão ISO 8601

Campo	Descrição	Tipo	Nullable	Observação
competencia	Ano e mês referente à competência do período que possui lançamentos financeiros	string	Não
data_fato_gerador	Data em que ocorreu o fato gerador	string	Não	Coluna descontinuada
fato_gerador	Fato gerador do lançamento financeiro	string	Não
tipo_lancamento	Tipo de lançamento financeiro	string	Não
descricao_lancamento	Descrição Lançamento	string	Não
valor	Valor do lançamento	double	Não
base_calculo	Valor utilizado para aplicação do percentual de taxas e comissão do iFood, para obter-se o valor cobrado	double	Sim
percentual_taxa	Percentual de taxa aplicada	double	Sim
pedido_associado_ifood	Identificador único do pedido na plataforma do iFood	string	Não
pedido_associado_ifood_curto	Identificador curto do pedido composto por 4 dígitos	string	Não
pedido_associado_externo	Identificador dos pedidos realizados por plataformas externas ao iFood (ex.: SiteMercado)	string	Sim	Coluna descontinuada
motivo_cancelamento	Motivo pelo qual o pedido ou item foi cancelado	string	Sim
descricao_ocorrencia	Motivo de haver uma ocorrência de crédito ou débito	string	Sim
data_criacao_pedido_associado	Data de criação do pedido	string	Não
data_repasse_esperada	Data esperada para a execução do pagamento para a loja	string	Sim
valor_transacao	Valor total da transação bancária (título) para a loja	double	Sim
loja_id	Identificador único da loja na plataforma do iFood	string	Não
loja_id_curto	Identificador curto da loja na plataforma do iFood composto de 4 dígitos	string	Não
loja_id_externo	Identificador da loja em plataformas externas ao iFood (ex.: SiteMercado)	string	Sim	Coluna descontinuada
cnpj	CNPJ da loja	string	Não
titulo	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para a loja	string	Sim	Coluna descontinuada, será substituída pela coluna id_saldo
data_faturamento	Data de faturamento do fato gerador	string	Sim
data_apuracao_inicio	Data de início do período dos lançamentos financeiros	string	Não
data_apuracao_fim	Data de fim do período dos lançamentos financeiros	string	Não
valor_cesta_inicial	Valor total dos itens antes da edição de cesta	double	Não	Coluna descontinuada
valor_cesta_final	Valor final dos itens após a edição de cesta, se houver	double	Não
responsavel_transacao	Entidade que acolheu o pagamento do pedido	string	Sim
canal_vendas	Canal de vendas pelo qual o pedido entra na plataforma (novos canais podem ser adicionados)	string	Sim
impacto_no_repasse	Indica quais lançamentos financeiros impactam a composição do valor líquido de repasse à loja parceira	string	Sim
parcela_pagamento	Em vendas com pagamento parcelado, este campo especifica qual parcela está sendo paga à loja.	string	Sim
id_saldo	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para a loja considerando os débitos e créditos	string	Sim
pedido_detalhes	Expõe mais detalhes de pedidos quando for necessário	string	Sim
metodo_pagamento	Indica método de pagamento utilizado na venda que originou o lançamento financeiro	string	Sim
bandeira_pagamento	Indica a bandeira utilizada no pagamento da venda que originou o lançamento financeiro	string	Sim