Docs Financial Financial API v3

Conciliação financeira iFood

O módulo financeiro do iFood oferece APIs que facilitam a conciliação financeira para lojas parceiras, fornecendo dados detalhados sobre faturamento e liquidação com transparência e simplicidade, a fim de garantir clareza dos lançamentos financeiros que compõem os repassesCom as APIs Financeiras é possível automatizar a conciliação do iFood e acessar informações em larga escala, evitando erros operacionais e gerando mais valor para o negócio.Neste material, orientamos como usar este módulo de forma eficiente.

Introdução de conceitos financeiros do iFood

Pedido

No iFood, um pedido é um registro que começa com a solicitação de compra de um ou mais serviços por um usuário. Esses serviços podem ser prestados pelo próprio iFood, como a entrega, ou pelas lojas parceiras, como a venda de itens.Um pedido não se limita apenas à venda, ele é a referência para um fluxo de vários eventos financeiros. A venda é apenas um dos possíveis fatos geradores de eventos financeiros.Outros possíveis fatos geradores de eventos financeiros atrelados a um pedido são: cancelamento total (que pode acontecer antes ou depois da venda ser concretizada), cancelamento parcial (de itens), ressarcimentos (como por exemplo em casos de cancelamento que são de responsabilidade do iFood), ocorrência de venda, entre outros.

Venda

A venda representa a conclusão da contratação de um serviço, independentemente da forma de pagamento utilizada pelo consumidor (online ou offline). Cada venda possui características individuais que, juntamente com os dados do contrato, o iFood utiliza para calcular e compor o valor a ser recebido ou pago pela loja parceira.

Apuração

Apuração refere-se ao processo de calcular e analisar os resultados financeiros obtidos em um período, determinando o valor a ser repassado ou cobrado da loja parceira. O período utilizado como base pelo iFood para realização da apuração é semanal, com início às segundas-feiras e fim aos domingos. Todos os eventos financeiros ocorridos nesse período são apurados na segunda-feira subsequente.Caso o saldo da apuração seja positivo, há um valor a ser repassado à loja parceira e o pagamento é agendado conforme o plano de repasse contratado, como por exemplo o plano D30 (30 dias). Atualmente, o iFood realiza os pagamentos às quartas-feiras.Caso o saldo da apuração seja negativo, o iFood pode gerar um boleto de cobrança para a loja parceira ou carregar esse valor para ser descontado em um próximo repasse da mesma loja.

Competência

Ano e mês referente ao período que possui lançamentos financeiros.

Lançamentos Financeiros

Lançamentos financeiros são registros de eventos financeiros que incluem data, valor e natureza da operação. Eles podem impactar direta ou indiretamente a apuração financeira da loja parceira, ou até mesmo não ter impacto algum.Importante: um mesmo pedido pode gerar lançamentos financeiros em diferentes períodos de apuração. Sabendo que o período de apuração no iFood é semanal, de Segunda-feira à Domingo, considere o seguinte exemplo:

A venda do pedido foi realizada em um Domingo, gerando um lançamento financeiro na apuração da Semana 1.
Ocorreu o cancelamento do pedido no dia seguinte, Segunda-feira, gerando um lançamento financeiro na apuração da Semana 2.
O ressarcimento pelo cancelamento do pedido de responsabilidade do iFood foi realizado no mesmo dia do cancelamento, também na Segunda-feira, gerando outro lançamento financeiro na apuração da Semana 2.
Na Segunda-feira seguinte, uma semana após o ressarcimento, foi gerada uma ocorrência de débito ou crédito referente a esse pedido, gerando um lançamento financeiro na apuração da Semana 3.

Impacto no repasse

Lançamentos financeiros podem ou não ter impacto na apuração e consequentemente no repasse, sendo segregados em dois principais grupos nos relatórios de conciliação financeira do iFood: com impacto no repasse e sem impacto no repasse.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.

Entrada Financeira

Entrada financeira é o valor que o consumidor pagou por um pedido realizado, seja o recebedor do pagamento sendo o iFood ou a loja parceira.

Recebedor do pagamento

O recebedor do pagamento é a entidade que acolhe o pagamento do consumidor referente a uma determinada operação, podendo ser o iFood ou a loja parceira.

Pagamento via aplicativo do iFood: se o consumidor efetua o pagamento de um pedido diretamente no aplicativo do iFood, o iFood acolhe este pagamento para posteriormente repassar a quantia devida à loja parceira, sendo o iFood o recebedor do pagamento.
Pagamento com meal voucher (VA/VR): se o pagamento é feito com Vale Alimentação (VA) ou Vale Refeição (VR), o valor é enviado diretamente do emissor do cartão à loja parceira, sendo a loja o recebedor do pagamento.
Pagamento offline: se o consumidor efetua o pagamento do pedido de forma offline, o iFood não acolhe o pagamento, sendo a loja o recebedor do pagamento.

Subsídios

Os subsídios, também chamados de promoções, são um tipo de lançamento financeiro e apresentam comportamentos diferentes no cálculo do repasse, dependendo de quem incentivou e onde foram aplicados. Eles podem ser incentivados pela loja parceira ou pelo iFood e podem ser aplicados a itens da cesta ou ao delivery.

Promoção incentivada pelo iFood ou Indústria: este é um valor que o consumidor não pagou, mas o iFood adiciona esse valor na composição do repasse à loja parceira, pois trata-se de uma promoção oferecida pelo iFood ou pela indústria sobre um produto fornecido pela loja. Portanto, esses subsídios são representados como lançamentos financeiros positivos nos relatórios de conciliação financeira do iFood.
Promoção incentivada pela loja aplicada a itens: este é um valor que o consumidor não pagou, e o iFood não adiciona ou desconta esse valor na composição do repasse à loja parceira, pois trata-se de uma promoção oferecida pela loja sobre seu próprio produto. Apesar desses subsídios serem representados como lançamentos financeiros negativos nos relatórios de conciliação financeira do iFood, eles são exibidos somente com o intuito de trazer visibilidade à loja parceira da existência de subsídios nesses pedidos. Portanto, esses lançamentos são sinalizados como não tendo impacto no repasse, o que significa que não devem ser considerados no cálculo do valor a ser repassado para loja parceira.
Promoção incentivada pela loja aplicada ao delivery: este é um valor que o consumidor não pagou, mas o iFood desconta esse valor na composição do repasse à loja parceira, pois trata-se de uma promoção oferecida pela loja sobre um serviço fornecido pelo iFood (serviço de entrega). Apesar desses subsídios serem representados como lançamentos financeiros negativos nos relatórios de conciliação financeira do iFood, eles são exibidos somente com o intuito de trazer visibilidade à loja parceira da existência de subsídios nesses pedidos, pois o lançamento financeiro referente à Taxa de Entrega, que também é negativo, já realiza o desconto desse valor na composição do repasse à loja parceira. Portanto, esses lançamentos são sinalizados como não tendo impacto no repasse, o que significa que não devem ser considerados no cálculo do valor a ser repassado para loja parceira.
Promoção incentivada pela rede: este é um valor que o consumidor não pagou, mas o iFood adiciona esse valor na composição do repasse à loja parceira, pois a princípio o subsídio tem origem iFood e é pago posteriormente pelas redes das lojas ao iFood (modelo pós pago).

Importante: Em Março de 2024 alteramos o modo como exibimos nos relatórios de conciliação financeira do iFood os lançamentos financeiros de promoções incentivadas pela loja (itens e delivery) para este modo que foi descrito acima. Anteriormente, não havia segregação dos lançamentos financeiros quanto ao impacto no repasse. Para poder dar visibilidade à loja parceira sobre a existência de subsídios da loja nos pedidos, os lançamentos de promoções incentivadas pela loja (itens e delivery), que não têm impacto no repasse, eram registrados como lançamentos financeiros negativos e em contrapartida, esse mesmo valor, mas positivo, era adicionado ao montante de "Entrada Financeira" (valor pago pelo consumidor), mesmo que esse valor não tivesse sido efetivamente pago pelo consumidor. Dessa forma, o valor permanecia neutro no cálculo do repasse.

Base de cálculo

A base de cálculo refere-se ao valor sobre o qual o percentual de comissão do iFood é aplicado para determinar quanto a loja parceira pagará ao iFood por cada pedido realizado através da plataforma.Outras taxas que são cobradas da loja também são calculadas a partir desse valor e dos percentuais acordados em contrato.A base de cálculo para taxas e comissões considera apenas itens e serviços vendidos pela loja. Por exemplo, o valor da entrega quando realizada pelo iFood não é incluída na base de cálculo. As promoções incentivadas pela loja (itens ou delivery) ou pela rede também não são incluídas neste cálculo.

Repasse

Valor a ser transferido do iFood para a loja parceira, que refere-se à apuração positiva de um determinado período. O valor de repasse é composto pela soma dos lançamentos financeiros ocorridos dentro do período de apuração, incluindo tanto débitos quanto créditos, resultando em um montante positivo a ser repassado.

Registro de recebíveis

O registro de recebíveis é uma medida regulamentada pelo Banco Central do Brasil (BACEN), que permite a uma instituição financeira, com a qual um negócio possui um empréstimo, requisitar uma parcela ou a totalidade dos recebíveis desse negócio. Isso é feito para satisfazer o montante mensal acordado no empréstimo obtido diretamente com a instituição. Nessa situação, uma parte ou a totalidade dos recebíveis é direcionada à instituição financeira, em vez de ser enviada integralmente à loja parceira.Confira no blog para parceiros mais detalhes sobre registro de recebíveis.

Conjunto de APIs Financeiras V3

Quais APIs Financeiras compõe o conjunto

O conjunto de APIs Financeiras V3 é composto por três APIs:API de Conciliação: Retorna um arquivo CSV detalhado com todos os eventos financeiros de um determinado período, incluindo informações sobre repasses por pedido. Esse arquivo serve como base para a conciliação financeira.API de Liquidação: Fornece o valor líquido recebido pela loja e o valor de recebíveis enviados às instituições financeiras.O campo "título" na API de Conciliação corresponde ao campo "id" na API de Liquidação, permitindo a interligação dos dados entre as duas APIs.API de Antecipação: Fornece informações sobre os repasses que foram antecipados, quando a loja possui um plano de antecipação ativo.

O que mudou em relação à versão anterior

A versão V3 das APIs financeiras oferece uma experiência simplificada para a conciliação, pois elimina a necessidade de múltiplas chamadas a APIs, agilizando o processo e reduzindo a complexidade da integração.A versão V2 necessitava de integração com nove APIs distintas para acessar as movimentações financeiras de um período ou pedido, enquanto a versão V3 centraliza essas informações em uma única API de Conciliação.Na versão V2, a consulta ao valor líquido recebido pela loja exigia acesso a duas APIs distintas, uma para o repasse e outra para os registros de recebíveis. A V3 simplifica esse processo, reunindo todas essas informações em uma única API de Liquidação.A informação 'id do período' contida na antiga API de Períodos, consta tanto na API de Conciliação como 'título', quanto na API de Liquidação como 'id'. Essa informação é crucial para conectar os dados entre as duas APIs da V3.

Recomendações na migração para última versão

Recomendamos que todas as integradoras migrem para a última versão das APIs Financeiras.Baseado em eventos faturáveis do iFood, a API de Conciliação fornece dados a nível granular de lançamentos financeiros. Além disso, incorpora as regras de negócio do iFood e utiliza sinais positivos e negativos ao apresentar os valores dos eventos financeiros, tornando fácil a identificação dos valores a receber (créditos) e a pagar (débitos), otimizando a sua conciliação financeira.Importante: Atente-se à frequência de atualização da API de Conciliação. Caso a integradora realize uma conciliação de vendas em D+1, recomendamos que, por enquanto, continue sendo realizada através da API Sales 2.1. Assim que a V3 oferecer uma API específica para conciliação de vendas em D+1, essa será a opção recomendada. No entanto, para verificar movimentações financeiras e valores de repasse em um determinado período, recomendamos que utilize as APIs V3.

Conciliação de vendas em D+1: Utilize a API Sales 2.1. Em breve, a API V3 oferecerá uma nova funcionalidade para conciliação em D+1.
Conciliação financeira geral: Utilize as APIs V3.

Importante: Embora a API de Conciliação forneça informações sobre todas as vendas, incluindo as realizadas com vale-refeição (VR/VA), detalhes mais específicos sobre essas transações podem ser obtidos através da API Payment Details V2. Recomendamos o uso contínuo da API Payment Details V2 para esse fim, até que a versão V3 ofereça uma funcionalidade equivalente.Prazos de descontinuação das versões anteriores

Dezembro/2024: Descontinuação da Sales 1.0 e Sales 2.0. Permanecerá a Sales 2.1 e os demais endpoints da v2.
Junho/2025: Descontinuação da Sales 2.1 e os demais endpoints da v2.

Processo de homologação na última versão (V3)

Para iniciar a utilização da API Financeira V3, as integradoras precisam passar por um processo de homologação. A homologação visa trazer benefícios às lojas parceiras iFood e às integradoras, uma vez que a homologação é um processo que assegura que a integração esteja operando corretamente, facilitando as conciliações conforme critérios estabelecidos, para garantir segurança e confiabilidade nos resultadosO processo consiste em: 1- Entrar em contato com o time de integração do iFood pelo Portal do Desenvolvedor e agendar a reunião de homologação. Para isto, acesse o Portal do Desenvolvedor > Suporte > Chamados > Homologação. 2- A integradora receberá direcionamentos e um formulário a ser preenchido até o dia da reunião de homologação. As respostas devem demonstrar a compreensão da documentação da API, especialmente em relação aos casos de uso. Obs.: Todas perguntas devem ser respondidas consultando os dados do ambiente de teste da integradora, utilizando o header x-request-homologation = true nas chamadas dos dois endpoints. 3- Durante a reunião, serão revisadas as respostas do formulário, a implementação da API e a forma como as informações são apresentadas às lojas parceiras. 4- Ao final, a integradora receberá o resultado da homologação. Se aprovada: o time fornecerá as orientações para a criação do app; Se reprovada: o time pontuará as correções a serem realizadas e, após ajustes, a integradora poderá remarcar uma nova reunião de homologação. Enquanto não estiver aprovada, a integradora perde a autorização de operar em produção.

Vídeo demonstrativo: conciliando com as APIs Financeiras

Este vídeo tem o objetivo de demonstrar como utilizar as APIs v3 para realizar a conciliação financeira de uma loja.

API de Conciliação Financeira

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

A cada semana, o arquivo mensal existente é atualizado, sendo incrementado com os lançamentos do período semanal anterior.O período semanal compreende de segunda-feira à domingo e a apuração ocorre na segunda-feira seguinte ao término do período. O arquivo é atualizado com o incremento deste período sete dias após a apuração, na próxima segunda-feira.Considere o seguinte exemplo:

Período de apuração: 01/07/2024 à 07/07/2024 (segunda-feira à domingo)
Apuração: 08/07/2024 (segunda-feira)
Atualização do arquivo da competência de Julho, com incremento referente à essa apuração, ocorre em 15/07/2024 (segunda-feira)
Após este incremento, o arquivo da competência de Julho ainda estará incompleto, pois continuará recebendo incrementos nas semanas seguintes.
Após os incrementos semanais seguintes, o arquivo da competência de Julho possuirá todos os lançamentos financeiros contidos no período de 01/07/2024 à 31/07/2024.

Importante: o arquivo vai incorporando mais dados a cada atualização semanal, mas os dados já contidos no arquivo são imutáveis, uma vez que ele é incrementado somente após a apuração, e nenhum novo lançamento financeiro pode incidir em um período após seu encerramento e apuração semanal.Caso dentro de uma semana de apuração haja quebra de mês, cada lançamento financeiro contido dentro desta semana irá ser incrementado no arquivo da sua respectiva competência.Considere o seguinte exemplo:

Período de apuração: 29/07/2024 à 04/08/2024 (segunda-feira à domingo)
Apuração: 05/08/2024 (segunda-feira)
Atualização do arquivo da competência de Julho, com incremento referente ao dias 29/07 à 31/07, ocorre em 12/08/2024 (segunda-feira)
Atualização do arquivo da competência de Agosto, com incremento referente ao dias 01/08 à 04/08, ocorre em em: 12/08/2024 (segunda-feira)
Após este incremento, o arquivo da competência de Julho estará completo, possuindo todos os lançamentos financeiros contidos no período de 01/07/2024 à 31/07/2024.
Após este incremento, o arquivo da competência de Agosto ainda estará incompleto, pois continuará recebendo incrementos nas semanas seguintes.
Após os incrementos semanais seguintes, o arquivo da competência de Agosto possuirá todos os lançamentos financeiros contidos no período de 01/08/2024 à 30/08/2024.

Principais campos do arquivo

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
TBD	Novos lançamentos financeiros que ainda estão sendo mapeados para inclusão em alguma categoria acima ou em uma nova categoria

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

Entrada Financeira: Valor pago pelo usuário final. Comissão do iFood: Linha com informações sobre o fato gerador Comissão, trazendo o valor cobrado pelo serviço da plataforma do iFood. Taxa entrega iFood: Valor de taxa cobrada do parceiro pelo serviço do iFood Entrega. Taxas cobradas do usuário devidas ao iFood: Valor de taxa de pedido mínimo que é cobrado do cliente final, esse valor não faz parte dos itens do pedido, e também não compõe repasse do parceiro, é um valor que fica retido no iFood. Promoção incentivada pelo iFood: Linha com informações sobre o fato gerador de subsídio iFood, traz informações como valor de subsídio(Desconto de venda) que o iFood incentiva destinado ao cliente final, e esse valor é repassado para o Merchant para compor o valor dos itens do pedido. Promoção incentivada pela loja: Linha com informações sobre o fato gerador de subsídio merchant, traz informações de valor de subsídio(Desconto de venda) que o Merchant(Mercado/Restaurante) incentiva destinado ao cliente final, e esse valor não entra no valor de repasse para o merchant. Reembolso ifood: Valor de ressarcimento feito pelo iFood no caso de pedido cancelado, e é devido o reembolso para o parceiro. Solicitação de Frete (iFood entrega): Informações de quando existe uma solicitação de frete de iFood entrega contratada. Taxa transação iFood benefícios: Taxa transacional de iFood benefícios. Desconto da taxa transação iFood benefícios: Valor cobrado sobre a taxa transacional de iFood benefícios. Ajuste falha sistêmica: Valor para quando existe um ajuste financeiro a débito ou a crédito realizado por ter acontecido uma falha sistêmica dentro da plataforma do iFood. Cobrança meses anteriores: Informações referente a cobranças realizadas sobre competências anteriores. Restituição I.R.: Restituição do Imposto de Renda TBD: Novos lançamentos financeiros, ainda não mapeados

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, como eventuais cobranças de mensalidade.

Título

Cada título representa uma transação bancária realizada à loja parceira.Um repasse é composto por um ou mais títulos.E cada título é composto por diversos lançamentos financeiros.A soma do campo 'valor' de todos os lançamentos financeiros com impacto no repasse que compõem um mesmo título, deve ser igual ao valor apresentado no campo 'valor_transação' desse título.Um título 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.

Valor da transação

O valor correspondente a cada título é informado no campo 'valor_transação'.

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.O valor total previsto a ser repassado à loja em uma data específica é calculado somando-se o 'valor_transação' de todos os títulos com essa mesma data de repasse programada.

Descrição de todos os campos

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

Campo	Descrição	Tipo	Nullable
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
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
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
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
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
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

Casos de uso

Nesta seção apresentamos alguns casos de uso do arquivo de conciliação.

Valor líquido a receber

A soma de todos os lançamentos financeiros com impacto no repasse representa o valor líquido esperado para ser recebido pela loja no período analisado.O período escolhido para análise pode ser tanto competência (mês e ano), neste caso utilizar o campo 'competência' do arquivo, como pode ser alguma semana de apuração específica, neste caso utilizar os campos 'data_apuracao_inicio' e 'data_apuracao_fim'.Para os casos de uso apresentados na sequência, as análises foram realizadas por competência (Julho/2024).

Campos utilizados:

impacto_no_repasse
valor (soma)

Neste caso, o valor líquido esperado para ser recebido pela loja, decorrente das movimentações financeiras que ocorreram na competência, é de R$ 491.442,31.

Totalizadores por valor

A análise por totalizadores é útil para realizar a conciliação financeira em um nível macro e se dá por meio das possíveis maneiras de agrupar os dados do arquivo.Aqui trazemos algumas possibilidades de agrupamento dos dados, todas com foco no valor dos lançamentos, para se ter um panorama geral das movimentações financeiras ocorridas no período analisado e no impacto financeiro que tiveram.O período escolhido para análise pode ser tanto competência (mês e ano), neste caso utilizar o campo 'competência' do arquivo, como pode ser alguma semana de apuração específica, neste caso utilizar os campos 'data_apuracao_inicio' e 'data_apuracao_fim'.Para os casos de uso apresentados na sequência, as análises foram realizadas por competência (Julho/2024). Em todos agrupamentos é possível identificar que o valor líquido esperado para ser recebido pela loja, decorrente das movimentações financeiras que ocorreram na competência, é de R$ 491.442,31.

Agrupamento por Fato Gerador

Este agrupamento permite analisar qual foi o valor de lançamentos financeiros do período originados por cada fato gerador.

Campos utilizados:

impacto_no_repasse
fato_gerador
valor (soma)

A soma dos fatos geradores com impacto no repasse representa o valor líquido esperado para ser recebido pela loja, que é de R$ 491.442,31.Exemplo: Análise do valor gerado pelas vendas

Para obter o valor (de crédito ou débito) gerado pelas vendas: R$ 496.379,94
Selecionar o período desejado para análise;
Selecionar o fato gerador desejado para análise, neste caso ‘fator_gerador = Venda’;
Selecionar ‘impacto_no_repasse = SIM';
Somar valores do campo 'valor';

Para obter o valor gerado pelas vendas que não possui impacto no repasse: R$ 71.525,06 (Esses valores referem-se à: entradas financeiras de pedidos recebidos via loja, promoção incentivada pela loja e promoção incentivada pela loja no delivery).

Selecionar o período desejado para análise;
Selecionar o fato gerador desejado para análise, neste caso ‘fator_gerador = Venda’;
Selecionar ‘impacto_no_repasse = NAO';
Somar valores do campo 'valor';

Agrupamento por Tipo de Lançamento

Este agrupamento permite analisar qual foi o valor de lançamentos financeiros do período de acordo com sua natureza.

Campos utilizados:

impacto_no_repasse
tipo_lancamento
valor (soma)

A soma dos tipos de lançamento com impacto no repasse representa o valor líquido esperado para ser recebido pela loja, que é de R$ 491.442,31.Exemplo: Análise do valor de lançamentos financeiros categorizados como cobrançaPara obter o valor das cobranças realizadas pelo iFood: - R$ 135.073,09

Selecionar o período desejado para análise;
Selecionar o lançamento ‘tipo_lancamento = Cobrança’;
Somar valores do campo 'valor';

Agrupamento por Descrição do Lançamento

Este agrupamento permite analisar qual foi o valor de lançamentos financeiros do período de acordo com sua descrição.

Campos utilizados:

impacto_no_repasse
descricao_lancamento
valor (soma)

A soma dos lançamentos financeiros com impacto no repasse representa o valor líquido esperado para ser recebido pela loja, que é de R$ 491.442,31.Exemplo: Análise do valor de entrada financeira (valor pago pelo cliente)Para obter o valor de entrada financeira de pedidos recebido via iFood: R$ 677.296,10

Selecionar o período desejado para análise;
Selecionar o lançamento ‘descricao_lancamento = Entrada financeira’;
Selecionar ‘impacto_no_repasse = SIM' ou 'responsavel_transacao = IFOOD';
Somar valores do campo 'valor';

Para obter o valor de entrada financeira de pedidos recebido via loja: R$ 90.332,35

Selecionar o período desejado para análise;
Selecionar o lançamento ‘descricao_lancamento = Entrada financeira’;
Selecionar ‘impacto_no_repasse = NAO' ou 'responsavel_transacao = LOJA';
Somar valores do campo 'valor';

Exemplo: Análise do valor total investido pela loja parceira em promoçõesPara obter o valor de promoções incentivadas pela loja: R$ 10.006,04

Selecionar o período desejado para análise;
Selecionar o lançamento ‘descricao_lancamento = Promoção incentivada pela loja’;
Somar valores do campo 'valor';

Para obter o valor de promoções incentivadas pela loja no delivery: R$ 8.961,84

Selecionar o período desejado para análise;
Selecionar o lançamento ‘descricao_lancamento = Promoção incentivada pela loja no delivery’;
Somar valores do campo 'valor';

Exemplo: Análise do valor de comissão do iFoodPara obter o valor de cobrança de comissão do iFood: - R$ 108.708,63

Selecionar o período desejado para análise;
Selecionar o lançamento ‘descricao_lancamento = Comissão do iFood’;
Somar valores do campo 'valor';

Agrupamento por Título

Este agrupamento permite analisar qual o valor de cada título e quais as datas esperadas para o repasse de cada um.

Campos utilizados:

data_repasse_esperada
titulo
valor_transacao (média)

A soma dos títulos representa o valor líquido esperado para ser recebido pela loja, que é de R$ 491.442,31.Exemplo: Análise dos títulos com data esperada de repasse em 10/07/2024Para obter a quantidade de títulos que existem no repasse com data esperada em 10/07/2024: dois títulos (110825088 e 110825091)

Selecionar ‘data_repasse_esperada = 2024-07-10’;
Contar a quantidade única de títulos que aparece no campo 'titulo';

Para obter a soma dos valores dos títulos do repasse com data esperada em 10/07/2024: R$ 98.722,50

Selecionar ‘data_repasse_esperada = 2024-07-10’;
Somar apenas uma vez o valor de cada título no campo 'valor_transacao';

Validação dos valores do arquivo

O valor de cada título deve corresponder à somatória do valor de todos os lançamentos financeiros vinculados àquele título. Esta validação é uma boa maneira de verificar se o arquivo está completo e correto.

Campos utilizados:

data_repasse_esperada
titulo
valor_transacao (média)
valor (soma)

Realizar a validação da seguinte maneira:

Selecionar um título no campo 'titulo';
Verificar o valor do título, informado no campo 'valor_transacao';
Selecionar 'impacto_no_repasse = SIM';
Somar o valor de todos os lançamentos financeiros no campo 'valor';
Verificar se a soma do valor de todos os lançamentos financeiros corresponde ao mesmo valor do título.

Totalizadores por quantidade de pedidos

Agrupamento por Fato Gerador

Este agrupamento permite analisar a quantidade de pedidos do período de acordo com o fato gerador.

Campos utilizados:

responsavel_transacao
fato_gerador
pedido_associado_ifood (contar únicos)

Exemplo: Análise da quantidade de vendasPara obter a quantidade de vendas total: 5.464

Selecionar o período desejado para análise;
Selecionar o fato gerador desejado para análise, neste caso ‘fator_gerador = Venda’;
Contar a quantidade única de pedidos que aparece no campo 'pedido_associado_ifood';

Para obter a quantidade de vendas em que o responsável da transação foi o iFood (pagamento recebido via iFood): 4.583

Selecionar o período desejado para análise;
Selecionar o fato gerador desejado para análise, neste caso ‘fator_gerador = Venda’;
Selecionar 'responsavel_transacao = IFOOD'
Contar a quantidade única de pedidos que aparece no campo 'pedido_associado_ifood';

Para obter a quantidade de vendas em que o responsável da transação foi a loja parceira (pagamento recebido via loja): 881

Selecionar o período desejado para análise;
Selecionar o fato gerador desejado para análise, neste caso ‘fator_gerador = Venda’;
Selecionar 'responsavel_transacao = LOJA'
Contar a quantidade única de pedidos que aparece no campo 'pedido_associado_ifood';

Análise por pedido

Valor a ser repassado pela venda do pedido

O valor líquido a ser repassado para a loja parceira pela venda de um pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'impacto_no_repasse = SIM'.O cálculo do repasse parte do valor de entrada financeira (valor pago pelo cliente), e então são sinalizadas todas as retenções, cobranças, eventuais subsídios, reembolsos e ressarcimentos que incidiram neste pedido, com seus devidos sinais de positivo e negativo, que sinalizam se foram créditos ou débitos realizados ao valor de entrada financeira.Neste caso o valor de repasse do pedido é de R$ 2,53.Os valores de promoções incentivadas pela loja são meramente informativos e por isso são sinalizados como 'impacto_no_repasse = NAO'.

Base de cálculo para taxas e comissão iFood

O campo 'base_calculo' informa qual foi o valor base utilizado para o cálculo das taxas e comissão iFood, enquanto o campo 'percentual_taxa' informa qual foi a taxa (de acordo com o percentual de taxas acordadas em contrato) aplicada em cima do valor base. Neste caso, podemos evidenciar que foram realizados os seguintes cálculos:Comissão do iFood = R$ 13,00 15% = R$ 1,95 Taxa de transação = R$ 13,00 2,6% = R$ 0,34 Taxa de antecipação do plano de repasse = R$ 13,00 * 1,49% = R$ 0,19

Venda com cancelamento total sem ressarcimento

Quando há cancelamento, desfazemos todos os lançamentos financeiros atrelados à venda. Para isso, há 2 fatos geradores, Venda e Cancelamento Total, que possuem os mesmos lançamentos porém com valores que se anulam, zerando o valor a ser repassado para a loja por este pedido.

O valor líquido a ser repassado para a loja parceira pela venda de um pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Venda' e 'impacto_no_repasse = SIM'.Neste caso, o valor de repasse da venda do pedido é de R$ 165,06.O valor líquido a ser descontado da loja parceira pelo cancelamento de um pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Cancelamento Total' e 'impacto_no_repasse = SIM'.Neste caso, o valor de cobrança pelo cancelamento do pedido é de - R$ 165,06.Portanto, o valor final de repasse desse pedido é zero.

Venda com cancelamento total com ressarcimento

Assim como acontece no cancelamento sem ressarcimento, toda a venda é desfeita, criando os fatos geradores de Venda e Cancelamento Total que se anulam.Porém, é gerado um novo lançamento único de Ressarcimento/Indenização, que já desconta comissão e demais taxas, representando o valor de repasse da venda como se ela tivesse sido concluída. Portanto, o valor a ser repassado para a loja por este pedido é positivo.

O valor líquido a ser repassado para a loja parceira pela Venda de um pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Venda' e 'impacto_no_repasse = SIM'.Neste caso, o valor de repasse da venda do pedido é de R$ 40,86.O valor líquido a ser descontado da loja parceira pelo Cancelamento Total de um pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Cancelamento Total' e 'impacto_no_repasse = SIM'.Neste caso, o valor de cobrança pelo cancelamento do pedido é de - R$ 40,86.O valor líquido a ser repassado para a loja parceira pelo Ressarcimento/Indenização de um pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Ressarcimento/Indenização' e 'impacto_no_repasse = SIM'.Neste caso, o valor de ressarcimento do pedido é de R$ 40,86.Portanto, o valor final de repasse desse pedido é de R$ 40,86.

Venda com cancelamento parcial sem ressarcimento

Os valores de cancelamentos parciais debitam do valor total líquido a receber por pedido.Os valores de taxas e comissões cobradas são recalculados proporcionalmente ao valor do cancelamento parcial.

Venda com cancelamento parcial com ressarcimento

Os pedidos com cancelamento parcial com ressarcimento seguem a mesma base de cálculo dos pedidos sem ressarcimento, porém, diferentemente do cancelamento total, os lançamentos de ressarcimento são demonstrados um a um, por terem base de cálculo diferentes do valor do pedido original.

O valor líquido a ser repassado para a loja parceira pela Venda de um pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Venda' e 'impacto_no_repasse = SIM'. Neste caso, o valor de repasse da venda do pedido é de R$ 170,03.O valor líquido a ser descontado da loja parceira pelo Cancelamento Parcial de um pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Cancelamento Parcial' e 'impacto_no_repasse = SIM'. Neste caso, o valor de cobrança pelo cancelamento parcial do pedido é de - R$ 73,09.O valor líquido a ser repassado para a loja parceira pelo Ressarcimento/Indenização de um pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Ressarcimento/Indenização' e 'impacto_no_repasse = SIM'. Neste caso, o valor de ressarcimento do pedido é de R$ 73,09.Portanto, o valor final de repasse desse pedido é de R$ 170,03.

Como identificar os pedidos que foram realizados com pagamento offline ou utilizando meal voucher (VA/VR)

Em vendas com pagamento offline, o valor é recebido diretamente pela loja parceira, sem intermediação do iFood. Isso inclui pagamentos realizados:

Via maquininha: Utilizando cartões de crédito, débito ou outros meios disponíveis.
Em dinheiro: Pagamento em espécie diretamente ao estabelecimento.
Com vale-refeição/alimentação (VA/VR): Embora a transação seja iniciada na plataforma iFood, o valor é creditado diretamente à conta da loja parceira pela adquirente.

Importante: Mesmo não intermediando o pagamento, o iFood aplica taxas e comissões sobre essas vendas, as quais são debitadas do repasse da loja parceira.Para identificar os pedidos realizados com método de pagamento offline ou utilizando cartões VA/VR é necessário utilizar o campo 'responsavel_transacao = LOJA'.Se 'responsavel_transacao = LOJA' (Pagamento offline ou VA/VR), significa que o valor desse pedido não será repassado pelo iFood à loja parceira, pois ela receberá diretamente do adquirente.Se 'responsavel_transacao = IFOOD' (Pagamento online pela plataforma iFood), significa que o valor desse pedido será repassado pelo iFood à loja parceira.

Para estes pedidos, o lançamento de Entrada Financeira (valor pago pelo cliente) possui 'impacto_no_repasse = NAO', uma vez que esse pagamento não foi acolhido pelo iFood e portanto não interfere no cálculo do repasse deste pedido. Exibimos esse lançamento apenas a fim de dar visibilidade para a loja parceira do valor que foi pago pelo cliente.O valor líquido a ser repassado ou cobrado da loja parceira pela Venda deste pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Venda' e 'impacto_no_repasse = SIM'.Neste caso, o valor de cobrança que o iFood necessita realizar da loja referente à venda do pedido é de - R$ 11,04.

Como identificar Solicitações de entrega iFood

Para identificar solicitações de frete iFood, verifique o campo 'descricao_lancamento'. Os valores possíveis são: "Solicitação de Frete (iFood entrega)", "Solicitação de entrega Sob Demanda On" e "Solicitação de entrega Sob Demanda Off". A descrição indica o tipo de serviço de entrega contratado e pode incluir uma taxa de serviço. A solicitação de frete pode ocorrer para pedidos que tiveram o pagamento offline via loja, ou online via iFood. A solicitação é informada como um pedido associado iFood, e a data da solicitação é informada como data de criação do pedido associado. Exemplo com 'responsavel_transacao = IFOOD':

O valor líquido a ser repassado ou cobrado da loja parceira pela Venda deste pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Venda' e 'impacto_no_repasse = SIM'. Neste caso, o valor de repasse da venda do pedido é de R$ 256,44.Exemplo com 'responsavel_transacao = LOJA':

O valor líquido a ser repassado ou cobrado da loja parceira pela Venda deste pedido, é a somatória do campo 'valor' de todas as linhas do arquivo atreladas a este pedido (campo 'pedido_associado_ifood'), que possuem 'fato gerador = Venda' e 'impacto_no_repasse = SIM'. Neste caso, o valor de cobrança que o iFood necessita realizar da loja referente à venda do pedido é de - R$ 12,19.

Como identificar taxas cobradas do cliente final

As taxas que o iFood cobra do cliente final, são sinalizadas com 'tipo_lancamento = Retenção', como por exemplo a 'Taxa de Entrega iFood' e a 'Taxa de serviço iFood cobrada do cliente'.Esses valores não são cobrados da loja parceira, são apenas retidos pelo iFood do pagamento realizado pelo cliente final, tanto se o pagamento é recebido pelo iFood ('responsavel_transacao = IFOOD') quanto se é recebido pela loja ('responsavel_transacao = LOJA').Quando a loja é responsável por receber o pagamento do cliente, o iFood realiza o reembolso de um percentual da "Taxa de serviço iFood cobrada do cliente". Esse reembolso é previsto em contrato e tem como objetivo compensar a loja por ter sido a responsável pela transação financeira.

API de Liquidação

Principais campos

Balance

Valor líquido recebido pela loja parceira. O valor recebido não necessariamente é igual ao valor que era esperado a receber pela loja, por exemplo quando houve efeito de contrato de registro de recebíveis sobre o valor original esperado de repasse.

Closing items

São os itens que compõem o fechamento do período. Detalha todos os títulos contidos no período, bem como seus status e valores.

Type

É a classificação dos itens de fechamento. As classificações existentes atualmente são: Repasse: Representa o pagamento realizado à loja parceira referente ao valor líquido das vendas realizadas em um determinado período. É gerado quando o saldo financeiro da loja em relação ao iFood é positivo. Boleto: Emitido quando a loja possui um saldo devedor ao iFood, proveniente de um período de apuração com resultado negativo. Esse valor pode ser compensado em futuros repasses da loja ou se emitido um boleto para esta cobrança, através do pagamento do boleto. Renegociada: Indica que uma transação original sofreu alterações em seus termos. Geralmente, ocorre quando há a necessidade de renegociar uma dívida da loja com uma instituição financeira. Nesse caso, o valor original da transação é dividido em duas partes: uma para quitar a dívida ('type: REGISTRO_RECEBIVEIS') e outra para ser repassada à loja ('type: REPASSE'). A transação original, antes da renegociação, é classificada como 'type: RENEGOCIADA'. Registro de recebíveis: Representa a parte do valor de uma venda que é retida para o pagamento de uma dívida da loja parceira com uma instituição financeira. Essa retenção ocorre quando a loja possui um acordo de recebíveis, no qual parte das suas vendas são destinadas ao pagamento de uma dívida.

Product

Informa a qual produto do iFood refere-se cada título. Os possíveis produtos são:

Produto
IFOOD
IFOOD_SHOP
WHITELABEL
ANOTA_AI
MAQUINONA

Amount

Valor do título representado em cada item de fechamento.

Payment Date

Data do pagamento efetuado para a loja parceira.

Descrição de todos campos

Campos	Descrição
beginDate	Início do período de chamada da API
endDate	Fim do período de chamada da API
balance	Valor recebido pela loja parceira
merchantId	Identificador único da loja na plataforma do iFood
startDateCalculation	Início do período de apuração
endDateCalculation	Fim do período de apuração
closingItems	Itens que compõe o fechamento do período
id	Id do título
type	Tipo do item de fechamento
product	A qual produto do iFood refere-se o título
amount	Valor do título
status	Status do título
transactionId	Id da transação
accountDetails	Informações bancárias
bankName	Nome do banco
bankNumber	Número do banco
branchCode	Código da filial
accountNumber	Número da conta
accountDigit	Dígito da conta
documentNumber	CNPJ da loja
paymentDate	Data de pagamento

Casos de uso

Nesta seção apresentamos um caso de uso da API de Liquidação.Considere este exemplo de resposta da API que está representado no payload abaixo.O que podemos interpretar desta resposta:Período de apuração: 2024-07-01 à 2024-07-07 Data esperada do repasse: 2024-07-10Títulos gerados nesta apuração: Título 110825091, valor R$ 84.640,09 Título 110825088, valor R$ 14.082,41 total: R$ 98.722,50Valor de repasse esperado para a loja parceira: R$ 98.722,50.Título repassado direta e integralmente para à loja parceira: 110825088, valor R$ 14.082,41.Título renegociado (sujeito à efeito de contrato de registro de recebíveis): 110825091, valor R$ 84.640,09.Montante do título renegociado que foi repassado para instituições financeiras, devido à efeito de contrato de registro de recebíveis: R$ 64.653,33.Montante do título renegociado que foi repassado para à loja parceira: R$ 19.986,76.Valor de repasse efetuado para a loja parceira: R$ 34.069,17.

{
  "beginDate": "2024-07-01",
  "endDate": "2024-07-07",
  "balance": 34069.17,
  "merchantId": "b00ff000-0a0d-0c00-a0c0-b0f00000e000",
  "settlements": [
    {
      "startDateCalculation": "2024-07-01",
      "endDateCalculation": "2024-07-07",
      "closingItems": [
        {
          "id": "110825091",
          "type": "RENEGOCIADA",
          "product": "IFOOD",
          "amount": 84640.09,
          "status": "TRANSFER_RENEGOTIATED",
          "accountDetails": {},
          "paymentDate": "2024-07-10"
        },
        {
          "id": "110825088",
          "type": "REPASSE",
          "product": "IFOOD",
          "amount": 14082.41,
          "status": "SUCCEED",
          "transactionId": "7d05deb7-b12a-4226-b4d6-cd3b0b682ca8",
          "accountDetails": {
            "bankName": "BANCO XPTO S.A.",
            "bankNumber": "022",
            "branchCode": "0001",
            "accountNumber": "44416444",
            "accountDigit": "4",
            "documentNumber": "24222444222444"
          },
          "paymentDate": "2024-07-10"
        }
      ]
    },
    {
      "startDateCalculation": "2024-07-01",
      "endDateCalculation": "2024-07-01",
      "closingItems": [
        {
          "id": "26500250",
          "type": "REPASSE",
          "product": "IFOOD",
          "amount": 5770.78,
          "status": "SUCCEED",
          "transactionId": "202407100000373089271",
          "accountDetails": {
            "bankName": "BANCO XPTO S.A.",
            "bankNumber": "022",
            "branchCode": "0001",
            "accountNumber": "44416444",
            "accountDigit": "4",
            "documentNumber": "24222444222444"
          },
          "paymentDate": "2024-07-10"
        },
        {
          "id": "26500247",
          "type": "REGISTRO_RECEBIVEIS",
          "product": "IFOOD",
          "amount": 39183.5,
          "status": "SUCCEED",
          "transactionId": "202407090000370333877",
          "accountDetails": {
            "bankName": "BANCO XPTO S.A.",
            "bankNumber": "022",
            "branchCode": "0001",
            "accountNumber": "44416444",
            "accountDigit": "4",
            "documentNumber": "24222444222444"
          },
          "paymentDate": "2024-07-10"
        },
        {
          "id": "26500253",
          "type": "REPASSE",
          "product": "IFOOD",
          "amount": 2235.39,
          "status": "SUCCEED",
          "transactionId": "202407100000373089239",
          "accountDetails": {
            "bankName": "BANCO XPTO S.A.",
            "bankNumber": "022",
            "branchCode": "0001",
            "accountNumber": "44416444",
            "accountDigit": "4",
            "documentNumber": "24222444222444"
          },
          "paymentDate": "2024-07-10"
        },
        {
          "id": "26500252",
          "type": "REPASSE",
          "product": "IFOOD",
          "amount": 7039.42,
          "status": "SUCCEED",
          "transactionId": "202407090000370334263",
          "accountDetails": {
            "bankName": "BANCO XPTO S.A.",
            "bankNumber": "022",
            "branchCode": "0001",
            "accountNumber": "44416444",
            "accountDigit": "4",
            "documentNumber": "24222444222444"
          },
          "paymentDate": "2024-07-10"
        },
        {
          "id": "26500248",
          "type": "REGISTRO_RECEBIVEIS",
          "product": "IFOOD",
          "amount": 25469.83,
          "status": "SUCCEED",
          "transactionId": "202407090000370334091",
          "accountDetails": {
            "bankName": "BANCO XPTO S.A.",
            "bankNumber": "022",
            "branchCode": "0001",
            "accountNumber": "44416444",
            "accountDigit": "4",
            "documentNumber": "24222444222444"
          },
          "paymentDate": "2024-07-10"
        },
        {
          "id": "26500255",
          "type": "REPASSE",
          "product": "IFOOD",
          "amount": 4664.45,
          "status": "SUCCEED",
          "transactionId": "202407090000370331133",
          "accountDetails": {
            "bankName": "BANCO XPTO S.A.",
            "bankNumber": "022",
            "branchCode": "0001",
            "accountNumber": "44416444",
            "accountDigit": "4",
            "documentNumber": "24222444222444"
          },
          "paymentDate": "2024-07-10"
        },
        {
          "id": "26500256",
          "type": "REPASSE",
          "product": "IFOOD",
          "amount": 276.72,
          "status": "SUCCEED",
          "transactionId": "202407100000373089298",
          "accountDetails": {
            "bankName": "BANCO XPTO S.A.",
            "bankNumber": "022",
            "branchCode": "0001",
            "accountNumber": "44416444",
            "accountDigit": "4",
            "documentNumber": "24222444222444"
          },
          "paymentDate": "2024-07-10"
        }
      ]
    }
  ]
}

API de Antecipação

Esta documentação detalha o uso da API de Antecipação de Pagamentos do iFood Pago, destinada às lojas parceiras do iFood que possuem algum plano de antecipação de repasse, via Conta Digital. O objetivo é fornecer instruções claras sobre como utilizar a API para gerenciar antecipações de pagamento.

Sobre Antecipação de Pagamentos

O plano padrão de repasse do iFood é de+30 (recebimento em até 4 semanas). Com o iFood Pago, as lojas parceiras têm a possibilidade de antecipar os repasses realizados pelo iFood. No entanto, antecipações não são permitidas para pagamentos efetuados com Vale Refeição ou Vale Alimentação, exceto iFood Benefícios. As lojas podem escolher a opção que melhor atende suas necessidades de recebimento, de acordo com os planos de antecipação disponíveis para contratação (D+1 e D+7).Os planos são contratados via Conta Digital iFood e a ativação da antecipação é realizada por CNPJ, ou seja, todas as lojas vinculadas ao CNPJ terão os repasses antecipados conforme opção contratada no App da Conta Digital iFood.

Planos de Antecipação

Plano D+1: Antecipação diária, recebimento no próximo dia útil.
Plano D+7: Antecipação semanal, recebimento na quarta-feira da semana seguinte.

Requisitos para contratação de antecipação

Possuir Conta Digital iFood
Receber o repasse das vendas na Conta Digital iFood
A agenda de recebíveis não pode estar comprometida com outras instituições financeiras.

Ativação do plano de antecipação

As ativações do plano de antecipação acontecem sempre às segundas-feiras.Veja alguns exemplos a seguir:Plano de antecipação D7Exemplo 1: A loja solicita a ativação na segunda-feira. A ativação é realizada na segunda-feira da semana seguinte à solicitação, e o primeiro crédito ocorre na quarta-feira da semana seguinte à ativação (a loja realiza vendas de segunda a domingo para receber na semana seguinte).

Exemplo 2: A loja solicita a ativação na quinta-feira. A ativação é realizada na segunda-feira da semana seguinte à solicitação, e o primeiro crédito ocorre na quarta-feira da semana seguinte à ativação (a loja realiza vendas de segunda a domingo para receber na semana seguinte).

Plano de antecipação D1Exemplo 1: A loja solicita a ativação na segunda-feira. A ativação é realizada na segunda-feira da semana seguinte à solicitação, e o primeiro crédito ocorre na terça-feira da semana da ativação (a loja realiza vendas durante um dia para receber no dia útil seguinte).

Exemplo 2: A loja solicita a ativação na quinta-feira. A ativação é realizada na segunda-feira da semana seguinte à solicitação, e o primeiro crédito ocorre na terça-feira da semana da ativação (a loja realiza vendas durante um dia para receber no dia útil seguinte).

Descrição de todos os campos

Parâmetros Requeridos

merchantId: ID único da loja (obrigatório).
Datas de apuração ou de recebimento do pagamento antecipado (apenas um período de datas é obrigatório, à escolha do usuário):
beginCalculationDate e endCalculationDate
beginAnticipatedPaymentDate e endAnticipatedPaymentDate

Descrição de todos campos

beginDate e endDate: Indicam o período total da consulta.
balance: Saldo total das antecipações realizadas no período. É a soma de todos os "anticipatedPaymentAmount".
merchantId: ID da loja que realizou a consulta.
settlements: Um array com os detalhes de cada período de cálculo.
- startDateCalculation e endDateCalculation: Período específico de apuração das vendas no iFood
- closingItems: Um array com os detalhes de cada antecipação dentro do período de apuração, incluindo:
  - type: Tipo de antecipação (semanal, diária).
  - originalPaymentAmount: Valor original do pagamento.
  - feePercentage: Taxa percentual da antecipação.
  - feeAmount: Valor da taxa.
  - anticipatedPaymentAmount: Valor líquido recebido na antecipação.
  - status: Status da antecipação (SUCCEED, FAILED, etc.).
  - accountDetails: Detalhes da conta bancária para o crédito.
  - originalPaymentDate: Data original do pagamento.
  - anticipatedPaymentDate: Data do pagamento antecipado.

Casos de uso

Nesta seção apresentamos um caso de uso da API de Antecipação.Considere este exemplo de resposta da API representado no payload abaixo.

{
  "beginDate": "2025-01-01",
  "endDate": "2025-01-16",
  "balance": 23185.9,
  "merchantId": "000c00bf-000f-00c0-b000-00ad000b0ee0",
  "settlements": [
    {
      "startDateCalculation": "2025-01-06",
      "endDateCalculation": "2025-01-12",
      "closingItems": [
        {
          "type": "REPASSE_ANTECIPADO_SEMANAL",
          "originalPaymentAmount": 7780.48,
          "feePercentage": 1.49,
          "feeAmount": 115.93,
          "anticipatedPaymentAmount": 7664.55,
          "status": "SUCCEED",
          "accountDetails": {
            "bankName": "BANCO DO BRASIL S.A.",
            "bankNumber": "013",
            "branchCode": "001",
            "accountNumber": "011223330",
            "accountDigit": "1"
          },
          "originalPaymentDate": "2025-02-05",
          "anticipatedPaymentDate": "2025-01-15"
        },
        {
          "type": "REPASSE_ANTECIPADO_SEMANAL",
          "originalPaymentAmount": 7007.49,
          "feePercentage": 1.49,
          "feeAmount": 104.41,
          "anticipatedPaymentAmount": 6903.08,
          "status": "SUCCEED",
          "accountDetails": {
            "bankName": "BANCO DO BRASIL S.A.",
            "bankNumber": "013",
            "branchCode": "001",
            "accountNumber": "011223330",
            "accountDigit": "1"
          },
          "originalPaymentDate": "2025-02-05",
          "anticipatedPaymentDate": "2025-01-15"
        }
      ]
    },
    {
      "startDateCalculation": "2025-01-01",
      "endDateCalculation": "2025-01-05",
      "closingItems": [
        {
          "type": "REPASSE_ANTECIPADO_SEMANAL",
          "originalPaymentAmount": 4046.91,
          "feePercentage": 1.49,
          "feeAmount": 60.3,
          "anticipatedPaymentAmount": 3986.61,
          "status": "SUCCEED",
          "accountDetails": {
            "bankName": "BANCO DO BRASIL S.A.",
            "bankNumber": "013",
            "branchCode": "001",
            "accountNumber": "011223330",
            "accountDigit": "1"
          },
          "originalPaymentDate": "2025-01-29",
          "anticipatedPaymentDate": "2025-01-08"
        },
        {
          "type": "REPASSE_ANTECIPADO_SEMANAL",
          "originalPaymentAmount": 4701.72,
          "feePercentage": 1.49,
          "feeAmount": 70.06,
          "anticipatedPaymentAmount": 4631.66,
          "status": "SUCCEED",
          "accountDetails": {
            "bankName": "BANCO DO BRASIL S.A.",
            "bankNumber": "013",
            "branchCode": "001",
            "accountNumber": "011223330",
            "accountDigit": "1"
          },
          "originalPaymentDate": "2025-01-29",
          "anticipatedPaymentDate": "2025-01-08"
        }
      ]
    }
  ]
}

O que podemos interpretar desta resposta:

O usuário consultou o período de 01/01/2025 a 16/01/2025, utilizando os parâmetros beginCalculationDate e endCalculationDate, além do merchantId da loja.
O plano contratado pela loja é para antecipação semanal, conforme indicado no campo type.
O valor total do pagamento antecipado para o período consultado foi de R$ 23.185,90, conforme exibido no campo balance. Este valor é a soma de todos os anticipatedPaymentAmount.
Dentro do período consultado, foram identificados dois intervalos de apuração de vendas da loja nos quais ocorreu a antecipação dos pagamentos:
- Para o período de apuração de 01/01/2025 à 05/01/2025:
  - O valor total a ser pago é de R$ 8.618,27. O pagamento original estava programado para 29/01/2025, mas com a antecipação, foi realizado em 08/01/2025.
- Para o período de apuração entre 06/01/2025 à 12/01/2025:
  - O valor total a ser pago é de R$ 14.567,63. O pagamento original estava previsto para 05/02/2025, mas, devido à antecipação, foi efetuado em 15/01/2025.
Os dados bancários indicam a conta na qual as lojas parceiras receberão os valores antecipados de pagamento.