Docs Financial Detalhes das APIs de Conciliação

Detalhes

Sales

Aqui será exibido detalhes gerais do pedido

Campo	Tipo	Descrição	Nulo
orderId	uuid	Identificador único do pedido na plataforma do iFood	Não
orderDate	string	Data de criação do pedido no formato YYYY-MM-DD	Não
orderDateTime	datetime	Data e hora de criação do pedido no formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	Não
lastProcessingDate	string	Data do último processamento do pedido no formato YYYY-MM-DD	Não
lastProcessingDateTime	datetime	Data e hora do último processamento do pedido no formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	Não
orderStatus	string	Status atualizado do pedido. Quando for faturado pelo iFood, o pedido sempre será exibido como CONCLUDED. No entanto pedidos que foram cancelados antes de serem faturados, e que não possuem movimentação financeira retornam com status CANCELLED	Não
companyName	string	Nome do merchant cadastrado na plataforma do iFood.	Não
documentNumber	string	Número do documento de identificação do merchant (CNPJ/CPF)	Não
businessModelOrder	string	Modelo de negócio contratado no iFood Valores possíveis: FULL_SERVICE - o merchant utiliza a logística do iFood para realizar entregas MARKETPLACE ou MKT_DELIVERY - o merchant utiliza a própria logística para realizar entregas ON_DEMAND, HYBRID ou HYBRID_REGION - o merchant utiliza a própria logística para realizar entregas, porém está habilitado para solicitar entregadores do iFood	Não
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Sim
salesChannel	string	Canal de vendas pelo qual o pedido entrou na plataforma, novos canais podem ser adicionados a qualquer momento. SHOPPING DIGITAL_CATALOG IFOOD POS – Pedidos de solicitação de logística (Sob Demanda)	Sim
deliveryProviderType	string	Identificação do provedor responsável pela entrega Valores possíveis: IFOOD - quando o tipo do provedor da entrega for do IFood MERCHANT - quando o tipo do provedor da entrega for de restaurante OTHERS - quando o provedor é de outro tipo	Sim
displayId	string	Identificador curto do pedido composto por 4 dígitos, mesmo valor apresentado no order e no portal do parceiro (ShortId)	Sim

Aqui será apresentado detalhes do registro de pagamento do consumidor para o pedido

Campo	Tipo	Descrição	Nulo
payment.type	string	Tipo do pagamento do pedido Valores possíveis: ONLINE - o pedido foi pago de forma online, dentro do app OFFLINE - o pedido foi pago de forma offline, fora do app	Não
payment.method	string	Método de pagamento do pedido, quando pago offline as informações podem ser diferentes das realizadas, visto que não temos acesso a qualquer alteração no momento do pagamento. Valores possíveis: CREDIT - Pago com cartão de crédito DEBIT - Pago com cartão de débito MEAL_VOUCHER - Pago com cartões do tipo VA/VR (vale alimentação/vale refeição) FOOD_VOUCHER - Pago com cartão iFood benefícios PIX – Pago com a forma de pagamento Pix BANK_PAY – pagamento direto pela conta do banco CASH – Dinheiro DIGITAL_WALLET – Pago com o saldo da carteira do iFood	Não
payment.brand	string	Bandeira do cartão utilizado para pagamento do pedido	Sim
payment.liability	string	Entidade que acolheu o pagamento do pedido. Valores possíveis: MERCHANT - Quando o Merchant acolhe o valor que o consumidor pagou referente ao pedido, mesmo que este tenha sido pago pelo aplicativo, como exemplo VA ou VR, neste caso o iFood não possui valores a serem repassados para o estabelecimento. IFOOD - Quando o iFood acolhe o valor que o consumidor pagou referente ao pedido, neste cenário o iFood é o intermediário e irá realizar o repasse para o estabelecimento, deduzindo as taxas.	Não
payment.cardNumber	string	últimos 4 dígitos do cartão utilizado para pagamento do pedido	Sim
payment.nsu	string	número sequencial único da transação	Sim

Aqui será exibido os detalhes de valores referentes ao faturamento do pedido

Campo	Tipo	Descrição	Nulo
billing.gmv	double	Valor total da venda, incluindo a taxa de entrega.	Não
billing.initialTotalBag	double	Valor inicial da cesta (produtos/itens) quando o pedido foi aceitou pelo merchant.	Não
billing.totalBag	double	Valor final total da cesta (produtos/itens) contidos no pedido.	Não
billing.deliveryFee	double	Valor da taxa de entrega cobrada do consumidor no pedido	Não
billing.consumerPaymentIfood	double	Valor pago pelo consumidor no pedido	Não
billing.deliveryFeeIfood	double	Valor da taxa de entrega cobrada pelo iFood para realizar a entrega do pedido	Não
billing.benefitIfood	double	Valor do subsídio financeiro concedido pelo iFood no pedido	Não
billing.benefitMerchant	double	Valor do subsídio financeiro concedido pelo merchant no pedido	Não
billing.commission	double	Valor da comissão do pedido cobrada pelo iFood para a realização da intermediação da venda	Não
billing.acquirerFee	double	valor da taxa cobrada pelo adquirente referente ao pedido	Não
billing.deliveryCommission	double	Comissão cobrada quando o modelo de negócio é ON_DEMAND, HYBRID ou HYBRID_REGION	Não
billing.commissionRate	double	Percentual de comissão de intermediação do pedido cobrado do iFood para o Merchant	Não
billing.acquirerFeeRate	double	Percentual de taxa cobrada pela transação do pagamento referente ao pedido	Não
billing.totalDebit	double	Valor total cobrado pelo iFood para a realização do pedido, composto pela comissão + taxas	Não
billing.totalCredit	double	Valor total que o merchant teria direito referente ao pedido, incluindo o pagamento do consumidor e benefícios concedidos pelo iFood para este pedido, para saber o valor líquido do repasse, deve-se subtrair o valor informado neste campo do totalDebit	Não
billing.anticipationFee	double	Valor da taxa de antecipação cobrado referente ao pedido conforme plano de repasse contratado.	Não
billing.anticipationFeeRate	double	Percentual da taxa de antecipação cobrado referente ao pedido	Não
billing.smallOrderFee	double	Valor total de todas as taxas cobradas do consumidor pelo iFood Para a realização do pedido	Não
billing.benefitPaymentCredit	double	Valor utilizado no pagamento com iFood Benefícios	Não
billing.benefitAcquirerFee	double	Valor reembolsado da taxa cobrada pela transação do pagamento do iFood Benefícios.	Não
billing.otherDebits	double	Objeto que possui outros débitos que foram cobrados pelo iFood para a realização da operação do pedido	Não
billing.otherCredits	double	Objeto que possui outros créditos que ocorreram durante a realização da operação do pedido	Não

Detalhes de transferência (dados bancários)

Detalhes esperados para a realização da transferência bancária (dados bancários), podendo vir nulos ou serem divergentes dos executados, em virtude das mudanças de cadastro solicitadas pelo Merchant entre a venda e a realização do repasse.

Campo	Tipo	Descrição	Nulo
transfer.expectedTransferDate	string	Data esperada para a realização da transferência deste pedido no formato YYYY-MM-DD	Sim
transfer.expectedBankAccount.bankNumber	string	Código COMPE do banco para a realização da transferência	Sim
transfer.expectedBankAccount.bankName	string	Nome do banco para a transferência	Sim
transfer.expectedBankAccount.branchCode	string	Código da agência do banco para a transferência	Sim
transfer.expectedBankAccount.branchCodeDigit	string	Dígito da agência do banco para a transferência	Sim
transfer.expectedBankAccount.accountNumber	string	Número da conta do banco para a transferência	Sim
transfer.expectedBankAccount.accountNumberDigit	string	Dígito do número da conta do banco para a transferência	Sim

Metadados

Campo	Tipo	Descrição	Nulo
metadata.siteMercado.id	string	Refere-se ao id interno dos pedidos realizados na plataforma iFood Mercado, este número refere-se ao codigoLoja.	Sim

Exemplo:

[
  {
    "orderId": "1233b1ae-3632-4039-84f1-b62b79fab7b2",
    "orderDate": "2020-09-16",
    "lastProcessingDate": "2020-09-25",
    "orderStatus": "CONCLUDED",
    "companyName": "IFOOD.COM AGENCIA DE RESTAURANTES ONLINE S.A.",
    "documentNumber": "12345678900",
    "businessModelOrder": "FULL_SERVICE",
    "periodId": "187",
    "salesChannel": "DIGITAL_CATALOG",
    "displayId": "8922",
    "payment": {
      "type": "OFFLINE",
      "method": "CREDIT",
      "brand": "MASTERCARD",
      "liability": "INTERNAL",
      "cardNumber": ""
    },
    "billing": {
      "gmv": 25.0,
      "totalBag": 25.0,
      "deliveryFee": 0.0,
      "consumerPaymentIfood": 0.0,
      "deliveryFeeIfood": 0.0,
      "benefitIfood": 10.0,
      "benefitMerchant": 0.0,
      "commission": -7.8045,
      "acquirerFee": 0.0,
      "deliveryCommission": 0.0,
      "commissionRate": 0.215,
      "acquirerFeeRate": 0.0,
      "totalDebit": 9.6195,
      "totalCredit": 38.115,
      "anticipationFee": 0.0,
      "anticipationFeeRate": 0.0,
      "smallOrderFee": 0.0,
      "benefitPaymentCredit": 0.0,
      "benefitAcquirerFee": 0.0,
      "otherDebits": 0.0,
      "otherCredits": 0.0
    },
    "transfer": {
      "expectedTransferDate": "2020-10-01",
      "expectedBankAccount": {
        "bankNumber": "237",
        "bankName": "Banco A S.A.",
        "branchCode": "1234",
        "branchCodeDigit": "",
        "accountNumber": "123456",
        "accountNumberDigit": "7"
      }
    },
    "orderDateTime": "2021-03-17T02:55:41Z",
    "lastProcessingDateTime": "2021-03-17T02:55:41Z"
  },
  {
    "orderId": "12332b7e-fa57-48f5-97e2-eac8ce50842b",
    "orderDate": "2020-09-21",
    "lastProcessingDate": "2020-09-25",
    "orderStatus": "CONCLUDED",
    "companyName": "IFOOD.COM AGENCIA DE RESTAURANTES ONLINE S.A.",
    "documentNumber": "12345678900",
    "businessModelOrder": "FULL_SERVICE",
    "periodId": "187",
    "payment": {
      "type": "OFFLINE",
      "method": "CREDIT",
      "brand": "MASTERCARD",
      "liability": "INTERNAL",
      "cardNumber": ""
    },
    "billing": {
      "gmv": 25.0,
      "totalBag": 25.0,
      "deliveryFee": 0.0,
      "consumerPaymentIfood": 0.0,
      "deliveryFeeIfood": 0.0,
      "benefitIfood": 10.0,
      "benefitMerchant": 0.0,
      "commission": -7.8045,
      "acquirerFee": 0.0,
      "deliveryCommission": 0.0,
      "commissionRate": 0.215,
      "acquirerFeeRate": 0.0,
      "totalDebit": 9.6195,
      "totalCredit": 38.115,
      "anticipationFee": 0.0,
      "anticipationFeeRate": 0.0,
      "benefitPaymentCredit": 0.0,
      "benefitAcquirerFee": 0.0,
      "otherDebits": 0.0,
      "otherCredits": 0.0
    },
    "transfer": {
      "expectedTransferDate": "2020-10-01",
      "expectedBankAccount": {
        "bankNumber": "237",
        "bankName": "Banco A S.A.",
        "branchCode": "1234",
        "branchCodeDigit": "",
        "accountNumber": "123456",
        "accountNumberDigit": "7"
      }
    },
    "orderDateTime": null,
    "lastProcessingDateTime": null,
    "metadata": {
      "siteMercado": {
        "id": null
      }
    }
  }
]

Occurrences

Campo	Tipo	Descrição	Nulo
merchantName	string	Nome do merchant cadastrado na plataforma do iFood.	Não
documentNumber	string	Número do documento de identificação do merchant (CNPJ/CPF)	Não
paymentPlan	string	Plano de repasse contratado pelo Merchant, conforme contrato vigente Valores possíveis: “D+7” (Repasse em 7 Dias) “D+30” (Repasse em 30 Dias)	Não
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Sim
expectedPaymentDate	string	Data esperada para realização da transferência do repasse para o Merchant, no formato YYYY-MM-DD	Não
transactionId	string	Identificador único da ocorrência	Não
transactionDate	string	Data de lançamento da ocorrência, no formato YYYY-MM-DD	Não
transactionDateTime	string	Data e hora em que foi realizada o lançamento da ocorrência, no formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	Não
type	string	Classificação do tipo de lançamento da ocorrência Valores possíveis: CREDIT - a ocorrência gerou um crédito para o merchant DEBIT - a ocorrência gerou um débito para o merchant	Não
amount	double	Valor total do lançamento.	Não
reason	string	Categorização do tipo de lançamento	Não
description	string	Justificativa/motivador para o lançamento da ocorrência.	Sim
orderId	uuid	Quando o lançamento é vinculado a um pedido, o identificador único do pedido virá preenchido neste campo, caso o lançamento não possua pedido vinculado, o campo virá nulo.	Sim
orderDate	string	Quando o lançamento é vinculado a um pedido, a data de criação do pedido virá preenchido neste campo, no formato YYYY-MM-DD, caso o lançamento não possua pedido vinculado, o campo virá nulo.	Sim
referencePeriodId	string	Identificador de referência do Período de origem que gerou o lançamento desta ocorrência.	Sim

Exemplo:

[
  {
    "merchantName": "NOME DO MERCHANT",
    "paymentPlan": "D+7 (Repasse em 7 Dias)",
    "periodId": "387",
    "expectedPaymentDate": "2021-02-24",
    "transactionId": "577806",
    "transactionDate": "2021-02-17",
    "type": "DEBIT",
    "amount": 0.01,
    "reason": "Credito por producao de pedido cancelado",
    "orderNumber": "1489499581",
    "orderId": "321498ba-33cd-40b6-9400-769f0fa42353",
    "orderDate": "2020-10-01",
    "description": "Credito por producao de pedido cancelado",
    "documentNumber": "22944414000101",
    "transactionDateTime": "2021-03-17T02:55:41Z",
    "referencePeriodId": "123"
  }
]

MaintenanceFees

Campo	Tipo	Descrição	Nulo
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Não
expectedPaymentDate	string	Data esperada para realização da transferência do repasse para o Merchant, no formato YYYY-MM-DD	Não
transactionId	string	Identificador único do lançamento da mensalidade.	Não
transactionDate	string	Data de lançamento da taxa de mensalidade, no formato YYYY-MM-DD.	Não
transactionDateTime	string	Data e hora em que foi realizada o lançamento da taxa de mensalidade, no formato YYYY-MM-DDTHH:MM:SS.ssssss-GM	Não
type	string	Tipo da taxa Valores possíveis: REGULAR – Cobrança da taxa fixa/regular da mensalidade ADJUSTMENT_FLEX_PRICE_PROGRESSIVE – Ajuste na cobrança da taxa progressiva de mensalidade FLEX_PRICE_PROGRESSIVE – Cobrança da taxa progressiva de mensalidade ADJUSTMENT – Ajuste na cobrança da taxa de mensalidade	Não
amount	double	Valor total do lançamento da taxa de mensalidade, podendo ser um valor positivo ou negativo, a depender do lançamento (cobrança ou ajuste)	Não

Exemplo:

[
  {
    "periodId": "169",
    "expectedPaymentDate": "2020-12-20",
    "transactionId": 90,
    "transactionDate": "2020-12-20",
    "type": "REGULAR",
    "amount": 12.345678
  }
]

IncomeTaxes

Campo	Tipo	Descrição	Nulo
merchantName	string	Nome do merchant cadastrado na plataforma do iFood.	Não
paymentPlan	string	Plano de repasse contratado pelo Merchant, conforme contrato vigente Valores possíveis: “D+7” (Repasse em 7 Dias) “D+30” (Repasse em 30 Dias)	Não
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Sim
expectedPaymentDate	string	Data esperada para realização da transferência do lançamento para o Merchant, no formato YYYY-MM-DD	Não
transactionId	string	Identificador único do lançamento do reembolso do imposto de renda	Não
transactionDate	string	Data de lançamento do reembolso do imposto de renda, no formato YYYY-MM-DD.	Não
transactionDateTime	string	Data e hora em que foi realizada o lançamento do reembolso do imposto de renda, no formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	Não
type	string	Tipo da taxa Valores possíveis: REGULAR – Lançamento do reembolso ADJUSTMENT – Ajuste no lançamento do reembolso	Não
amount	double	Valor total do lançamento, podendo ser um valor positivo ou negativo, a depender do lançamento (reembolso ou ajuste)	Não

Exemplo:

[
  {
    "merchantName": "NOME DO MERCHANT",
    "paymentPlan": "D+7 (Repasse em 7 Dias)",
    "periodId": "169",
    "expectedPaymentDate": "2020-07-30",
    "transactionId": "43",
    "transactionDate": "2020-07-13",
    "amount": "15.345678",
    "type": "REGULAR"
  }
]

ChargeCancellations

Campo	Tipo	Descrição	Nulo
merchantName	string	Nome do merchant cadastrado na plataforma do iFood.	Não
paymentPlan	string	Plano de repasse contratado pelo Merchant, conforme contrato vigente Valores possíveis: “D+7” (Repasse em 7 Dias) “D+30” (Repasse em 30 Dias)	Não
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Sim
expectedPaymentDate	string	Data esperada para realização da transferência do lançamento para o Merchant, no formato YYYY-MM-DD	Não
transactionId	string	Identificador único do lançamento do reembolso do pedido cancelado.	Não
transactionDate	string	Data de lançamento do reembolso do pedido cancelado, no formato YYYY-MM-DD.	Não
transactionDateTime	string	Data e hora em que foi realizada o lançamento do reembolso do pedido cancelado, no formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	Não
amount	double	Valor total do lançamento do reembolso pelo cancelamento do pedido.	Não
orderId	uuid	Identificador único do pedido na plataforma do iFood que foi reembolsado	Não
orderDate	string	Data de criação do pedido que foi reembolsado no formato YYYY-MM-DD	Não
cancellationCode	string	Código do motivo de cancelamento conforme tabela de política de cancelamentos do iFood	Sim
cancellationCodeDescription	string	Descrição do motivo cancelamento conforme tabela de política de cancelamentos do iFood	Sim

Exemplo:

[
  {
    "merchantName": "Teste Merchant",
    "paymentPlan": "D30",
    "periodId": "169",
    "expectedPaymentDate": "2020-12-20",
    "transactionId": "1234",
    "transactionDate": "2020-12-20",
    "amount": 12.345678,
    "orderId": "e2bb5e56-4f75-11eb-ae93-0242ac130002",
    "orderDate": "2020-12-20",
    "cancellationCode": "123",
    "cancellationCodeDescription": "Entregador indisponível"
  }
]

Cancellations

Campo	Tipo	Descrição	Nulo
merchantName	string	Nome do merchant cadastrado na plataforma do iFood.	Não
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Não
merchantId	uuid	Identificador único do Merchant na plataforma do iFood	Não
orderId	uuid	Identificador único do pedido na plataforma do iFood	Não
cancellationDate	string	Data do cancelamento do pedido no formato YYYY-MM-DD	Não
orderDate	string	Data de criação do pedido que foi cancelado no formato YYYY-MM-DD	Não
amount	double	Valor total do cancelamento do pedido	Não
liability	string	Entidade que acolheu o pagamento do pedido. Valores possíveis: MERCHANT - Quando o Merchant acolhe o valor que o consumidor pagou referente ao pedido, mesmo que este tenha sido pago pelo aplicativo, como exemplo VA ou VR, neste caso o iFood não possui valores a serem repassados para o estabelecimento. IFOOD - Quando o iFood acolhe o valor que o consumidor pagou referente ao pedido, neste cenário o iFood é o intermediário e irá realizar o repasse para o estabelecimento, deduzindo as taxas.	Não
operationType	string	Classificação do tipo de lançamento Valores possíveis: CREDIT – O lançamento gerou um crédito para o merchan DEBIT – o lançamento gerou um débito para o merchant	Não
displayId	string	Identificador curto do pedido composto por 4 dígitos, mesmo valor apresentado no order e no portal do parceiro (ShortId)	Sim
cancellationCode	string	Código do motivo de cancelamento conforme tabela de política de cancelamentos do iFood	Sim
cancellationCodeDescription	string	Descrição do motivo cancelamento conforme tabela de política de cancelamentos do iFood	Sim

Exemplo:

[
  {
    "merchantName": "Nome do merchant",
    "periodId": null,
    "merchantId": "da4d59d9-d2f9-47c8-9156-622d52a03dd7",
    "orderId": "597796d3-f390-435d-b176-bd3f67cd2bb4",
    "cancellationDate": "2022-01-01",
    "orderDate": "2022-01-01",
    "amount": 800.0,
    "liability": "IFOOD",
    "operationType": "DEBIT",
    "displayId": "8922",
    "cancellationCode": "123",
    "cancellationCodeDescription": "Entregador indisponível"
  }
]

Payments

Informações gerais

Campo	Tipo	Descrição	Nulo
id	string	Identificador único do repasse para o merchant	Não
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Não
status	string	Status do repasse Valores possíveis: CREATED - Quando houve o fechamento semanal e o pagamento foi criado, porém não foi agendado SCHEDULED - Pagamento foi agendado com referência a data do campo expectedExecutionDate EXECUTED - Pagamento executado. A data de referência será a do campo confirmedPaymentDate ABORTED - Pagamentos que foram gerados, mas houve algum erro sistêmico. Serão geradas novos pagamentos e o pagamento com status ABORTED será desconsiderado SUSPENDED - Quando o merchant está na denylist por suspeita de fraude FAILED - Quando alcança o número máximo de tentativas de pagamento e não há sucesso DEADEND – Quando não será mais realizado a transferência. Exemplos: O Merchant pegou um empréstimo com garantia, desta forma esse repasse virou um registro de recebíveis O Merchant deu baixa no CNPJ, desta forma a transferência não pode mais ser executada.	Não
expectedExecutionDate	string	Data esperada para a execução do pagamento para o merchant	Não
nextExecutionDate	string	Próxima data útil de pagamento quando a data esperada de execução não cai em dia útil	Não
confirmedPaymentDate	string	Data de confirmação da realização do pagamento para o merchant	Sim
totalAmount	double	Valor total do pagamento para o merchant	Não
merchantsConsolidated	array	Quando um grupo merchants possui uma gestão centralizada, pode optar por centralizar o repasse em uma das lojas, chamamos de consolidador (loja que recebe o repasse) e consolidados (lojas que direcionam o repasse para uma outra loja), neste array informamos a lista de estabelecimentos que foram consolidados no Merchant do lançamento.	Sim
transactionCode	string	Código da transação executada	Sim
type	string	Tipo da origem do pagamento. Valores possíveis: FOOD_BENEFITS - Valor de repasse referente aos lançamentos financeiros ocorridos com iFood Benefícios PIX - Valor de repasse referente aos lançamentos financeiros ocorridos com PIX CREDIT_DEBIT - Valor de repasse referente aos lançamentos financeiros ocorridos com cartões de débito e de crédito.	Sim

Dados bancários

Campo	Tipo	Descrição	Nulo
bankAccount.bankName	string	Nome do banco para a transferência	Não
bankAccount.bankNumber	string	Código COMPE do banco para a realização da transferência	Não
bankAccount.branchCode	string	Código da agência do banco para a transferência	Não
bankAccount.branchCodeDigit	string	Dígito da agência do banco para a transferência	Não
bankAccount.number	string	Número da conta do banco para a transferência	Não
bankAccount.numberDigit	string	Dígito da conta do banco para a transferência	Não
bankAccount.document.type	string	Tipo do documento de identificação do titular da conta Valores possíveis: CNPJ CPF	Não
bankAccount.document.number	string	Número do documento de identificação	Não
bankAccount.document.documentHolderName	string	Nome da companhia/pessoa do documento de identificação	Não

Exemplo:

[
  {
    "id": "4",
    "periodId": "1",
    "status": "CREATED",
    "expectedExecutionDate": "2020-09-03",
    "nextExecutionDate": "2020-08-28",
    "confirmedPaymentDate": "2020-08-29",
    "totalAmount": 100,
    "bankAccount": {
      "bankName": "bank",
      "bankNumber": "123",
      "number": "001",
      "numberDigit": "0",
      "branchCode": "0",
      "branchCodeDigit": "0",
      "document": {
        "type": "CNPJ",
        "number": "432412",
        "documentHolderName": "Name"
      }
    },
    "merchantsConsolidated": [
      "126f89d6-db7b-4040-88ee-1e9cc0f3691a",
      "23217747-7f88-405c-92ce-08ea1b384b12",
      "c8225980-ae09-4c5b-855d-e25495e2543a"
    ],
    "transactionCode": "202210041234507052088",
    "type": "CREDIT_DEBIT"
  }
]

Period

Informações gerais

Campo	Tipo	Descrição	Nulo
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Não
merchantId	uuid	identificador único do Merchant na plataforma do iFood	Não
competence	string	ano e mês referente à competência do período que possui lançamentos financeiros	Não
expectedDate	string	data esperada da transferência/pagamento do repasse do período	Não
status	string	Status do período Valores possíveis: ABERTO - Quando o período ainda encontra-se em aberto no iFood e pode sofrer alterações. FECHADO - Quando o período já foi apurado e encontra-se fechado, sem possibilidade de alterações.	Não

Exemplo:

[
  {
    "periodId": "25467",
    "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "competence": "2021-09",
    "expectedDate": "2021-09-02",
    "status": "ABERTO"
  }
]

PaymentDetails

Informações gerais

Campo	Tipo	Descrição	Nulo
orderId	uuid	Identificador único do pedido na plataforma do iFood	Não
payment.status	string	Status do pagamento do consumidor para o referido pedido Valores possíveis: AUTHORIZED – autorizado, aguardando captura AUTHORIZED_CANCELLATION_PENDING – autorizado, pendente cancelamento AUTHORIZED_CANCELLATION_SUCCESSFUL – autorizado, cancelamento realizado com sucesso AUTHORIZED_CANCELLATION_FAILED – Autorizado, cancelamento falhou CAPTURE_SUCCESSFUL – transação capturada com sucesso CAPTURE_FAILED – Falha na captura da transação REFUND_PENDING – Estorno pendente de ser realizado REFUND_SUCCESSFUL – estorno realizado com sucesso REFUND_FAILED – Estorno falhou	Não
payment.type	string	Tipo da captura do pagamento, neste caso sempre ONLINE.	Não
payment.method	string	Método de pagamento do pedido, neste caso sempre MEAL_VOUCHER	Não
payment.brand	string	Bandeira do cartão utilizado para pagamento do pedido	Sim
payment.liability	string	Entidade que acolheu o pagamento do pedido. Valores possíveis: MERCHANT - Quando o Merchant acolhe o valor que o consumidor pagou referente ao pedido, mesmo que este tenha sido pago pelo aplicativo, como exemplo VA ou VR, neste caso o iFood não possui valores a serem repassados para o estabelecimento. MERCHANT_IFOOD_BENEFICIOS - Quando o iFood acolhe o valor que o consumidor pagou referente ao pedido, neste cenário o iFood é o intermediário e irá realizar o repasse para o estabelecimento, deduzindo as taxas.	Não
payment.cardNumber	string	Número do cartão utilizado para pagamento do pedido com máscara	Sim
payment.acquirer	string	Adquirente responsável pela autorização do pagamento	Sim
payment.nsu	string	Número sequencial único da transação fornecido pela adquirente	Sim
payment.authCode	string	Código de autorização fornecido pela adquirente	Não
payment.refundType	string	Tipo de estorno Valores possíveis: ORIGEM – Foi realizado o estorno direto no emissor do cartão WALLET – Foi realizado o estorno na carteira do iFood, neste caso, o iFood irá gerar uma cobrança ao Merchant, já que o mesmo irá receber o pagamento do emissor do cartão.	Sim
payment.refundValue	string	Valor do estorno	Sim
payment.refundDate	string	Data e hora do estorno	Sim
payment.paymentDate	string	Data e hora do pagamento do pedido	Não
payment.updatedAt	string	Data e hora da última atualização do pagamento	Não

Exemplo:

[
  {
    "orderId": "6054b4d2-fb73-47f4-bed4-10f402f4a0b7",
    "payment": {
      "status": "CAPTURE_SUCCESSFUL",
      "type": "ONLINE",
      "method": "CREDIT_CARD",
      "brand": "MASTERCARD",
      "liability": "INTERNAL",
      "cardNumber": "420868******2885",
      "acquirer": "ADYEN",
      "nsu": "123456",
      "authCode": "123",
      "refundType": "ORIGEM",
      "refundValue": "45.600000",
      "refundDate": "2023-08-11T13:22:00.671Z",
      "paymentDate": "2021-11-30T05:35:39Z",
      "updatedAt": "2021-11-30T05:35:39Z"
    }
  }
]

ReceivableRecords

Informações gerais

Campo	Tipo	Descrição	Nulo
merchantId	uuid	Identificador único do Merchant na plataforma do iFood	Não
originPaymentId	string	Identificador original e único do repasse, apresentando na api de Payments, antes de ter a transferência dividida para a instituição financeira.	Não
paymentSplit	array	Separação feita do repasse original, com os repasses feitos às instituições financeiras	Não
id	string	Identificador único do registro de recebível	Não
totalAmount	double	Valor total pago à instituição financeira	Não
date	string	Data do registro de recebível	Não
bankAccount.bankNumber	string	Número do banco que foi a transferência	Não
bankAccount.accountNumber	string	Número da conta do banco que foi feita a transferência	Não
bankAccount.numberDigit	string	Dígito do número da conta do banco que foi feita a transferência	Não
bankAccount.branchCode	string	Agência do banco que foi feita a transferência	Não
bankAccount.branchCodeDigit	string	Dígito da agência do banco que foi feita a transferência	Não
type	string	Tipo da conta domicilio que acolheu o repasse do recebível	Não
documentNumber	string	Número do documento de identificação do merchant (CNPJ/CPF)	Não
documentHolderName	string	Número do documento de identificação do merchant (CNPJ/CPF)	Não

Exemplo:

[
  {
    "merchantId": "da4d59d9-d2f9-47c8-9156-622d52a03dd7",
    "originPaymentId": "123",
    "paymentSplit": [
      {
        "id": "4321",
        "totalAmount": "2000.00",
        "date": "2020-01-01",
        "bankAccount": {
          "bankNumber": "123",
          "number": "001",
          "numberDigit": "0",
          "branchCode": "0",
          "branchCodeDigit": "0",
          "document": {
            "type": "CNPJ",
            "number": "432412",
            "documentHolderName": "Name"
          }
        }
      }
    ]
  }
]

SalesAdjustments

Informações gerais

Campo	Tipo	Descrição	Nulo
orderId	uuid	Identificador único do pedido na plataforma do iFood	Não
billedOrderId	uuid	Identificador único do refaturamento do pedido	Não
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Sim
documentNumber	string	Número do documento de identificação do merchant (CNPJ/CPF)	Não
orderDate	string	Data de criação do pedido no formato YYYY-MM-DD	Não
orderDateUpdate	string	Data que o pedido foi refaturado no formato YYYY-MM-DD	Não
orderDateTimeUpdate	string	Data e hora que o pedido foi refaturado no formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	Não
adjustmentAmount	double	Valor total do refaturamento do pedido, podendo ser positivo ou negativo	Não
expectedPaymentDate	string	Data esperada para realização da transferência do repasse para o Merchant, no formato YYYY-MM-DD	Não
billedOrderUpdate.gmv	double	Valor total da venda, incluindo a taxa de entrega após o refaturamento.	Não
billedOrderUpdate.totalBag	double	Valor final total da cesta (produtos/itens) contidos no pedido após o refaturamento.	Não
billedOrderUpdate.deliveryFee	double	Valor da taxa de entrega cobrada do consumidor no pedido	Não
billedOrderUpdate.benefitIfood	double	Valor do subsídio financeiro concedido pelo iFood no pedido	Não
billedOrderUpdate.benefitMerchant	double	Valor do subsídio financeiro concedido pelo merchant no pedido	Não
billedOrderUpdate.commission	double	Valor da comissão do pedido cobrada pelo iFood para a realização da intermediação da venda	Não
billedOrderUpdate.acquirerFee	double	Valor da taxa cobrada pela transação do pagamento (pagamento no app) referente ao pedido	Não
billedOrderUpdate.deliveryCommission	double	Comissão cobrada quando o modelo de negócio é ON_DEMAND, HYBRID ou HYBRID_REGION	Não
billedOrderUpdate.commissionRate	double	Percentual de comissão de intermediação do pedido cobrado do iFood para o Merchant	Não
billedOrderUpdate.acquirerFeeRate	double	Percentual de taxa cobrada pela transação do pagamento referente ao pedido	Não
billedOrderUpdate.totalDebit	double	Calor total cobrado pelo iFood para a realização do pedido, composto pela comissão + taxas	Não
billedOrderUpdate.totalCredit	double	Calor total que o merchant teria direito referente ao pedido, incluindo o pagamento do consumidor e benefícios concedidos pelo iFood para este pedido, para saber o valor líquido do repasse, deve-se subtrair o valor informado neste campo do totalDebit	Não
billedOrderUpdate.anticipationFee	double	Calor da taxa de antecipação cobrado referente ao pedido conforme plano de repasse contratado.	Não
billedOrderUpdate.anticipationFeeRate	double	Percentual da taxa de antecipação cobrado referente ao pedido	Não
billedOrderUpdate.smallOrderFee	double	Valor total de todas as taxas cobradas do consumidor pelo iFood para a realização do pedido	Não
displayId	string	Identificador curto do pedido composto por 4 dígitos, mesmo valor apresentado no order e no portal do parceiro (ShortId)	Sim
cancellationCode	string	Código do motivo de cancelamento conforme tabela de política de cancelamentos do iFood	Sim
cancellationCodeDescription	string	Descrição do motivo cancelamento conforme tabela de política de cancelamentos do iFood	Sim

Exemplo:

[
  {
    "orderId": "5c5fa01f-40d3-4ed1-839a-d3325dc42f56",
    "billedOrderId": "29a8790d-33de-4e33-996c-2fee3c0992d0",
    "periodId": "3421",
    "documentNumber": "76430438607960",
    "orderDate": "2022-07-04",
    "orderDateUpdate": "2022-07-04",
    "orderDateTimeUpdate": "2022-07-04 14:07:10",
    "adjustmentAmount": -11.7484,
    "expectedPaymentDate": "2022-07-05",
    "billedOrderUpdate": {
      "gmv": 56.19,
      "totalBag": 29.65,
      "deliveryFee": 8.99,
      "benefitIfood": 0.0,
      "benefitMerchant": 0.0,
      "commission": 1.0216,
      "acquirerFee": 0.0,
      "deliveryCommission": 0.0,
      "commissionRate": 0.08,
      "acquirerFeeRate": 0.0,
      "totalDebit": 2.7544,
      "totalCredit": 34.43,
      "anticipationFee": 0.0,
      "anticipationFeeRate": 0.0,
      "smallOrderFee": 0.0
    },
    "displayId": "5838",
    "cancellationCode": "123",
    "cancellationCodeDescription": "Entregador indisponível"
  }
]

SalesBenefits

Informações gerais

Campo	Tipo	Descrição	Nulo
orderId	uuid	Identificador único do pedido na plataforma do iFood	Não
displayId	string	Identificador curto do pedido composto por 4 dígitos, mesmo valor apresentado no order e no portal do parceiro (ShortId)	Sim
orderDate	string	Data de criação do pedido no formato YYYY-MM-DD	Não
totalAmount	double	Valor total bruto do pagamento	Não
taxPolAmount	double	Valor da taxa cobrada pela transação	Não
netAmount	double	Valor total líquido repassado ao merchant	Não
merchantId	string	Identificador único do Merchant na plataforma do iFood	Não
documentNumber	string	Número do documento de identificação do merchant (CNPJ/CPF)	Não
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Sim
expectedPaymentDate	string	Data esperada para realização da transferência do repasse para o Merchant, no formato YYYY-MM-DD	Não

Exemplo:

[
  {
    "orderId": "ce19c622-954c-498a-ba6b-60cd0b1889f9",
    "displayId": "5838",
    "orderDate": "2020-12-20",
    "totalAmount": "80.00",
    "taxPolAmount": "0.80",
    "netAmount": "79,20",
    "merchantId": "ce19c622-954c-498a-ba6b-60cd0b1889f9",
    "documentNumber": "9128217312",
    "periodId": "123456",
    "expectedPaymentDate": "2022-08-19"
  }
]

AdjustmentsBenefits

Informações gerais

Campo	Tipo	Descrição	Nulo
orderId	uuid	Identificador único do pedido na plataforma do iFood	Não
displayId	string	Identificador curto do pedido composto por 4 dígitos, mesmo valor apresentado no order e no portal do parceiro (ShortId)	Sim
orderDate	string	Data de criação do pedido no formato YYYY-MM-DD	Não
totalAmount	double	valor total bruto do pagamento após o refaturamento	Não
taxPolAmount	double	Valor da taxa cobrada pela transação após o refaturamento	Não
netAmount	double	valor total líquido repassado ao Merchant após o refaturamento	Não
merchantId	string	identificador único do Merchant na plataforma do iFood	Não
documentNumber	string	Número do documento de identificação do merchant (CNPJ/CPF)	Não
periodId	string	Identificador de agrupamento. Ele é utilizado para vincular os lançamentos financeiros ao repasse realizado para o merchant	Sim
codeEvent	integer	código do evento referente ao ajuste do pedido	Sim
typeEvent	string	tipo do ajuste do pedido, podendo ser: ADJUSTMENT – Quando ocorre um ajuste parcial no pedido (edição de um ou mais itens da cesta) FULL_CANCELLATION – Quando todos os itens do pedido são cancelados.	Sim
adjustmentDate	string	data de criação do refaturamento do pedido, no formato YYYY-MM-DD	Não
expectedPaymentDate	string	Data esperada para realização da transferência do repasse para o Merchant, no formato YYYY-MM-DD	Não

Exemplo:

[
  {
    "orderId": "ce19c622-954c-498a-ba6b-60cd0b1889f9",
    "displayId": "5838",
    "orderDate": "2020-12-20",
    "totalAmount": "80.79",
    "taxPolAmount": "0.79",
    "netAmount": "80,00",
    "merchantId": "ce19c622-954c-498a-ba6b-60cd0b1889f9",
    "documentNumber": "9128217312",
    "periodId": "123456",
    "adjustmentDate": "2022-10-09",
    "codeEvent": "2",
    "typeEvent": "Cancelamento Total",
    "expectedPaymentDate": "2022-08-19"
  }
]