Docs Financial Detalles de las API de conciliación

Detalles de las API de conciliación

Ventas

Campo	Tipo	Descripción	Nulo
orderId	uuid	Identificador único de pedido en la plataforma iFood	No
orderDate	string	Fecha de creación del pedido en formato YYYY-MM-DD	No
orderDateTime	datetime	Fecha y hora de creación del pedido en formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	No
lastProcessingDate	string	Fecha de la última tramitación del pedido en formato YYYY-MM-DD	No
lastProcessingDateTime	datetime	Fecha y hora del último procesamiento de la orden en el formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	No
orderStatus	string	Siempre se mostrará el estado del pedido cuando lo facture iFood CONCLUDED	No
companyName	string	Nombre del comerciante registrado en la plataforma iFood	No
documentNumber	string	Número de identificación del comerciante (CNPJ/CPF)	No
businessModelOrder	string	Modelo de negocio contratado por iFood Valores posibles: FULL_SERVICE - un comerciante utiliza la logística de iFood para hacer entregas MARKETPLACE ou MKT_DELIVERY - el comerciante utiliza su propia logística para realizar las entregas ON_DEMAND, HYBRID ou HYBRID_REGION - el comerciante utiliza su propia logística para realizar las entregas, pero puede solicitar los servicios de mensajería de iFood	No
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	Sí
salesChannel	string	Canal de venta a través del cual entró el pedido en la plataforma, se pueden añadir nuevos canales en cualquier momento. SHOPPING DIGITAL_CATALOG IFOOD POS – Solicitudes de logística (Sob Demanda)	Sí
deliveryProviderType	string	Identificación del proveedor responsable de la entrega Valores posibles: IFOOD - cuando el tipo de proveedor de entrega es IFood MERCHANT - cuando el tipo de proveedor de entrega es un restaurante OTHERS - cuando el proveedor es de otro tipo	Sí
displayId	string	Identificador de pedido corto de 4 dígitos, mismo valor que en el pedido y en el portal de socios. (ShortId)	Sí

Aquí verá los detalles del registro de pagos del cliente para el pedido

Campo	Tipo	Descripción	Nulo
payment.type	string	Tipo de pago del pedido Valores posibles: ONLINE - el pedido se pagó en línea, dentro de la aplicación OFFLINE - el pedido se pagó sin conexión, fuera de la aplicación	No
payment.method	string	Forma de pago del pedido, cuando se paga fuera de línea la información puede ser diferente de la realizada, ya que no tenemos acceso a ningún cambio en el momento del pago. Valores posibles: CREDIT - Pagado con tarjeta de crédito DEBIT - Pagado con tarjeta de débito MEAL_VOUCHER - Pagado con tarjetas como VA/VR (vale alimentação/vale refeição) FOOD_VOUCHER - Pagado con los beneficios de la tarjeta iFood PIX – Pagado con el método de pago Pix BANK_PAY – pago directo por cuenta bancaria CASH – Dinero DIGITAL_WALLET – Pagado con el saldo del monedero iFood	No
payment.brand	string	Indicador de la tarjeta utilizada para pagar el pedido	Sí
payment.liability	string	Entidad que aceptó el pago de la reclamación. Valores posibles: MERCHANT - Cuando el Comercio recibe el importe que el consumidor ha abonado por el pedido, aunque haya sido pagado por la aplicación, como VA o VR, en este caso iFood no tiene importes que repercutir al establecimiento. IFOOD - Cuando iFood cobra el importe que el consumidor ha pagado por el pedido, en este supuesto iFood es el intermediario y lo repercutirá al establecimiento, descontando las comisiones.	No
payment.cardNumber	string	4 últimos dígitos de la tarjeta utilizada para pagar el pedido	Sí
payment.nsu	string	Número secuencial único de transacción	Sí

Aquí verá los detalles de los importes de facturación del pedido

Campo	Tipo	Descripción	Nulo
billing.gmv	double	Valor total de la venta, incluidos los gastos de envío.	No
billing.initialTotalBag	double	Valor inicial de la cesta (productos/artículos) cuando el pedido fue aceptado por el comerciante.	No
billing.totalBag	double	Valor final total de la cesta (productos/artículos) contenida en el pedido.	No
billing.deliveryFee	double	Importe de los gastos de envío cobrados al consumidor en el pedido	No
billing.consumerPaymentIfood	double	Importe pagado por el consumidor por el pedido	No
billing.deliveryFeeIfood	double	Gastos de envío cobrados por iFood para entregar el pedido	No
billing.benefitIfood	double	Importe de la subvención financiera concedida por iFood en la solicitud	No
billing.benefitMerchant	double	Importe de la subvención financiera concedida por el comerciante en la solicitud	No
billing.commission	double	Importe de la comisión de pedido cobrada por iFood por intermediar en la venta	No
billing.acquirerFee	double	importe de la comisión cobrada por el comprador por el pedido	No
billing.deliveryCommission	double	Comisión cobrada cuando el modelo de negocio es ON_DEMAND, HYBRID ou HYBRID_REGION	No
billing.commissionRate	double	Porcentaje de la comisión de intermediación de pedidos que iFood cobra al Merchant	No
billing.acquirerFeeRate	double	Porcentaje de la comisión cobrada por la operación de pago relativa al pedido	No
billing.totalDebit	double	Importe total cobrado por iFood por realizar el pedido, compuesto por comisión + tasas	No
billing.totalCredit	double	Importe total que le correspondería al comerciante por el pedido, incluyendo el pago del consumidor y los beneficios otorgados por iFood por este pedido, para conocer el importe neto de la transferencia, debe restar el importe informado en este campo del totalDebit.	No
billing.anticipationFee	double	Cargo por adelantado del pedido según el plan de transferencia contratado.	No
billing.anticipationFeeRate	double	Porcentaje del anticipo cobrado por el pedido	No
billing.smallOrderFee	double	Valor total de todos los gastos cobrados al consumidor por iFood por realizar el pedido	No
billing.benefitPaymentCredit	double	Importe utilizado para pagar con iFood Beneficios	No
billing.benefitAcquirerFee	double	Importe reembolsado por la comisión de transacción cobrada por el pago del iFood Benefícios.	No
billing.otherDebits	double	Objeto que tiene otras deudas que han sido cargadas por iFood para llevar a cabo la operación de pedido.	No
billing.otherCredits	double	Objeto que tiene otros abonos que se produjeron durante la realización de la operación de pedido.	No

Detalles de la transferencia (datos bancarios)

Detalles esperados para la realización de la transferencia (datos bancarios), que pueden estar vacíos o ser diferentes de los ejecutados debido a los cambios solicitados por el comerciante entre la venta y el reembolso realizado.

Campo	Tipo	Descripción	Nulo
transfer.expectedTransferDate	string	Fecha prevista para realizar la transferencia de esta orden en formato AAAA-MM-DD	Sí
transfer.expectedBankAccount.bankNumber	string	Código COMPE del banco para realizar la transferencia	Sí
transfer.expectedBankAccount.bankName	string	Nombre del banco para la transferencia	Sí
transfer.expectedBankAccount.branchCode	string	Código de la sucursal bancaria para la transferencia	Sí
transfer.expectedBankAccount.branchCodeDigit	string	Dígito de la sucursal bancaria para la transferencia	Sí
transfer.expectedBankAccount.accountNumber	string	Número de cuenta bancaria para la transferencia	Sí
transfer.expectedBankAccount.accountNumberDigit	string	Dígito del número de cuenta bancaria para la transferencia	Sí

Metadatos

Campo	Tipo	Descrição	Nulo
metadata.siteMercado.id	string	Se refiere al identificador interno de los pedidos realizados en la plataforma iFood Mercado, este número se refiere al código de la tienda.	Sí

Ejemplo:

[
  {
    "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",
    "payment": {
      "type": "OFFLINE",
      "method": "CREDIT",
      "brand": "MASTERCARD",
      "liability": "INTERNAL",
      "cardNumber": ""
    },
    "billing": {
      "gmv": 25.0,
      "totalBag": 25.0,
      "deliveryFee": 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
    },
    "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"
  },
  {
    "orderNumber": "7654321",
    "orderDate": "2020-09-21",
    "orderId": "12332b7e-fa57-48f5-97e2-eac8ce50842b",
    "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,
      "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
    },
    "transfer": {
      "expectedTransferDate": "2020-10-01",
      "expectedBankAccount": {
        "bankNumber": "237",
        "bankName": "Banco A S.A.",
        "branchCode": "1234",
        "branchCodeDigit": "",
        "accountNumber": "123456",
        "accountNumberDigit": "7"
      }
    },
    "orderDateTime": null,
    "lastProcessingDateTime": null
  }
]

Incidentes

Campo	Tipo	Descripción	Nulo
merchantName	string	Nombre del comerciante registrado en la plataforma iFood.	No
documentNumber	string	Número de documento de identificación de comerciante (CNPJ/CPF)	No
paymentPlan	string	Plan de transferencia contratado por Comerciante, según contrato vigente Valores posibles: “D+7” (Reembolso en 7 días) “D+30” (Reembolso en 30 días)	No
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	Sí
expectedPaymentDate	string	Fecha prevista de transferencia al comerciante, en formato AAAA-MM-DD	No
transactionId	string	Identificador único de suceso	No
transactionDate	string	Fecha de contabilización de la incidencia, en formato YYYY-MM-DD	No
transactionDateTime	string	Fecha y hora de publicación de la incidencia, en el formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	No
type	string	Clasificación del tipo de desplazamiento del acontecimientoa Valores posibles: CREDIT - el evento generó un crédito para el comerciante DEBIT - la incidencia generó un débito para el comerciante	No
amount	double	Valor total de contabilización.	No
reason	string	Categorización del tipo de contabilización	No
description	string	Justificación/motivación para publicar la incidencia.	Sí
orderId	uuid	Cuando la contabilización está vinculada a un pedido de compra, el identificador único del pedido de compra se introducirá en este campo; si la contabilización no tiene un pedido de compra vinculado, el campo será nulo.	Sí
orderDate	string	Cuando la contabilización esté vinculada a una orden, se introducirá en este campo la fecha de creación de la orden, en el formato YYYY-MM-DD, si la contabilización no tiene orden vinculada, el campo será nulo.	Sí
referencePeriodId	string	Identificador de referencia del Período Fuente que generó la contabilización de esta incidencia.	Sí

Ejemplo:

[
  {
    "merchantName": "NOMBRE DEL COMERCIANTE",
    "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"
  }
]

MaintenanceFees

Campo	Tipo	Descripción	Nulo
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	No
expectedPaymentDate	string	Fecha prevista de transferencia al comerciante, en forma de YYYY-MM-DD	No
transactionId	string	Identificador único de la entrada de la cuota mensual.	No
transactionDate	string	Fecha de contabilización de la tasa de matrícula, en el formato YYYY-MM-DD.	No
transactionDateTime	string	Fecha y hora de contabilización de la tasa de matrícula, en el formato YYYY-MM-DDTHH:MM:SS.ssssss-GM	No
type	string	Tipo de tasa Valores posibles: REGULAR – Cobrar la cuota mensual fija/regular ADJUSTMENT_FLEX_PRICE_PROGRESSIVE – Ajuste de la cuota mensual progresiva FLEX_PRICE_PROGRESSIVE – Cobrar la cuota mensual progresiva ADJUSTMENT – Ajuste de la cuota mensual	No
amount	double	Importe total de la contabilización de la tasa de matrícula, que puede ser un importe positivo o negativo, en función de la contabilización (cargo o ajuste).	No

Ejemplo:

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

IncomeTaxes

Campo	Tipo	Descripción	Nulo
merchantName	string	Nombre del comerciante registrado en la plataforma iFood.	No
paymentPlan	string	Plan de transferencia contratado por Comerciante, según contrato vigente Valores posibles: “D+7” (Reembolso en 7 días) “D+30” (Reembolso en 30 días)	No
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	Sí
expectedPaymentDate	string	Fecha prevista para la transferencia de la liberación al comerciante, en el formato YYYY-MM-DD	No
transactionId	string	Identificador único de la contabilización de la devolución del impuesto sobre la renta	No
transactionDate	string	Fecha de contabilización de la devolución del impuesto sobre la renta, en el formato YYYY-MM-DD.	No
transactionDateTime	string	Fecha y hora en que se contabilizó la devolución del impuesto sobre la renta, en el formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	No
type	string	Tipo de tasa Valores posibles: REGULAR – Contabilización de devoluciones ADJUSTMENT – Ajuste por contabilización de devoluciones	No
amount	double	Ajuste en contabilización de reembolsoValor total de la contabilización, que puede ser un valor positivo o negativo, dependiendo de la contabilización (reembolso o ajuste).	No

Ejemplo:

[
  {
    "merchantName": "NOMBRE DEL COMERCIANTE",
    "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	Descripción	Nulo
merchantName	string	Nombre del comerciante registrado en la plataforma iFood.	No
paymentPlan	string	Plan de transferencia contratado por Comerciante, según contrato vigente Valores posibles: “D+7” (Reembolso en 7 días) “D+30” (Reembolso en 30 días)	No
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	Sí
expectedPaymentDate	string	Fecha prevista para la transferencia de la liberación al comerciante, en el formato YYYY-MM-DD	No
transactionId	string	Identificador único de la contabilización del reembolso del pedido cancelado.	No
transactionDate	string	Fecha de contabilización del reembolso del pedido anulado, en el formato YYYY-MM-DD.	No
transactionDateTime	string	Fecha y hora en que se envió el reembolso del pedido cancelado, en el formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	No
amount	double	Importe total de la contabilización del reembolso por anulación de pedido.	No
orderId	uuid	Identificador único del pedido en la plataforma iFood que se ha reembolsado.	No
orderDate	string	Fecha de creación del pedido reembolsado en el formato YYYY-MM-DD	No
cancellationCode	string	Código del motivo de cancelación según la tabla de política de cancelación de iFood	Sí
cancellationCodeDescription	string	Descripción del motivo de cancelación según la tabla de política de cancelación de iFood	Sí

Ejemplo:

[
  {
    "merchantName": "NOMBRE DEL COMERCIANTE",
    "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"
  }
]

Cancellations

Campo	Tipo	Descripción	Nulo
merchantName	string	Nombre del comerciante registrado en la plataforma iFood.	No
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	No
merchantId	uuid	Identificador único del comerciante en la plataforma iFood	No
orderId	uuid	Identificador único de pedido en la plataforma iFood	No
cancellationDate	string	Fecha de cancelación del pedido en el formato YYYY-MM-DD	No
orderDate	string	Fecha de creación de la orden anulada en el formato YYYY-MM-DD	No
amount	double	Importe total de la anulación del pedido	No
liability	string	Entidad que aceptó el pago de la reclamación. Valores posibles: MERCHANT - Cuando el Comercio recibe el importe que el consumidor ha abonado por el pedido, aunque haya sido pagado por la aplicación, como VA o VR, en este caso iFood no tiene importes que repercutir al establecimiento. IFOOD - Cuando iFood cobra el importe que el consumidor ha pagado por el pedido, en este supuesto iFood es el intermediario y lo repercutirá al establecimiento, descontando las comisiones.	No
operationType	string	Clasificación del tipo de contabilización Valores posibles: CREDIT – El lanzamiento generó un crédito para el comerciante DEBIT – la contabilización generó un débito para el comerciante	No
displayId	string	Identificador de pedido corto de 4 dígitos, mismo valor que en el pedido y en el portal de socios. (ShortId)	Sí
cancellationCode	string	Código del motivo de cancelación según la tabla de política de cancelación de iFood	Sí
cancellationCodeDescription	string	Descripción del motivo de cancelación según la tabla de política de cancelación de iFood	Sí

Ejemplo:

[
  {
    "merchantName": "NOMBRE DEL COMERCIANTE",
    "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"
  }
]

Payments

Información general

Campo	Tipo	Descripción	Nulo
id	string	Identificador único de la transferencia al comerciante	No
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	No
status	string	Estado de la transferencia Valores posibles: CREATED - Cuando se produjo el cierre semanal y se creó el pago, pero no se programó SCHEDULED -El pago se programó con referencia a la fecha de campo expectedExecutionDate EXECUTED - Pago ejecutado. La fecha de referencia será la que figure en el confirmedPaymentDate ABORTED - Pagos que se generaron pero hubo un error sistémico. Se generarán nuevos pagos y el pago con estado ABORTED no se tendrá en cuenta SUSPENDED - Cuando el comerciante está en la lista de denegación por sospecha de fraude FAILED - Cuando se alcanza el número máximo de intentos de pago y no hay éxito DEADEND – Cuándo dejará de realizarse la transferencia. Ejemplos: El comerciante suscribió un préstamo con garantía, por lo que este représtamo se convirtió en un registro de derechos de cobro El comerciante ha cancelado el CNPJ, por lo que la transferencia ya no puede ejecutarse.	No
expectedExecutionDate	string	Fecha prevista de ejecución del pago para el comerciante	No
nextExecutionDate	string	Próxima fecha de pago cuando la fecha de ejecución prevista no cae en día laborable	No
confirmedPaymentDate	string	Fecha de confirmación del pago al comerciante	Sí
totalAmount	double	Importe total pagado al comerciante	No
merchantsConsolidated	array	Cuando un grupo comercial tiene la gestión centralizada, puede optar por centralizar la transferencia a una de sus tiendas, que llamamos el consolidador (la tienda que recibe la transferencia) y los consolidadores (las tiendas que dirigen la transferencia a otra tienda). En esta matriz le informamos de la lista de tiendas que se han consolidado en el lanzamiento Merchant.	Sí
transactionCode	string	Código de la transacción ejecutada	Sí
type	string	Tipo de fuente de pago. Valores posibles: FOOD_BENEFITS - Valor de transferencia relativo a los asientos financieros con iFood Benefícios PIX - Valor de transferencia referido a los asientos financieros realizados con PIX CREDIT_DEBIT - Valor de transferencia relativo a las entradas financieras realizadas con tarjetas de débito y crédito.	Sí

Datos bancarios

Campo	Tipo	Descripción	Nulo
bankAccount.bankName	string	Nombre del banco para la transferencia	No
bankAccount.bankNumber	string	Código COMPE del banco para realizar la transferencia	No
bankAccount.branchCode	string	Código de la sucursal bancaria para la transferencia	No
bankAccount.branchCodeDigit	string	Dígito de la sucursal bancaria para la transferencia	No
bankAccount.number	string	Número de cuenta bancaria para la transferencia	No
bankAccount.numberDigit	string	Dígito de la cuenta bancaria para la transferencia	No
bankAccount.document.type	string	Tipo de documento de identificación del titular de la cuenta Valores posibles: CNPJ CPF	No
bankAccount.document.number	string	Número del documento de identificación	No
bankAccount.document.documentHolderName	string	Nombre de la empresa/persona que figura en el documento de identidad	No

Ejemplo:

[
  {
    "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"
    ]
  }
]

Periodo

Información general

Campo	Tipo	Descripción	Nulo
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	No
merchantId	uuid	Identificador único del comerciante en la plataforma iFood	No
competence	string	Año y mes del período en el que tiene contabilizaciones financieras	No
expectedDate	string	Fecha prevista para la transferencia/pago de los représtamos del período	No
status	string	Estado del período Valores posibles: ABERTO - El plazo sigue abierto en iFood y puede cambiar. FECHADO - Cuando el periodo ya se ha calculado y está cerrado, sin posibilidad de cambios.	No

Ejemplo:

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

PaymentDetails

Información general

Campo	Tipo	Descripción	Nulo
orderId	uuid	Identificador único de pedido en la plataforma iFood	No
payment.status	string	Estado de pago del consumidor para ese pedido Valores posibles: AUTHORIZED – autorizado, en espera de captura AUTHORIZED_CANCELLATION_PENDING – autorizado, pendiente de cancelación AUTHORIZED_CANCELLATION_SUCCESSFUL – autorizado, anulación con éxito AUTHORIZED_CANCELLATION_FAILED – Autorizado, cancelación fallida CAPTURE_SUCCESSFUL – transacción capturada con éxito CAPTURE_FAILED – No se ha podido capturar la transacción REFUND_PENDING – Devolución pendiente REFUND_SUCCESSFUL – devolución de cargo completada con éxito REFUND_FAILED – Devolución fallida	No
payment.type	string	Tipo de captura del pago, en este caso siempre ONLINE.	No
payment.method	string	Forma de pago del pedido, en este caso siempre MEAL_VOUCHER	No
payment.brand	string	Indicador de la tarjeta utilizada para pagar el pedido	Sí
payment.liability	string	Entidad que aceptó el pago de la reclamación. Valores posibles: MERCHANT - Cuando el Comercio recibe el importe que el consumidor ha abonado por el pedido, aunque haya sido pagado por la aplicación, como VA o VR, en este caso iFood no tiene importes que repercutir al establecimiento. MERCHANT_IFOOD_BENEFICIOS - Cuando iFood cobra el importe que el consumidor ha pagado por el pedido, en este supuesto iFood es el intermediario y lo repercutirá al establecimiento, descontando las comisiones.	No
payment.cardNumber	string	Número de tarjeta utilizado para pagar el pedido con una máscara	Sí
payment.acquirer	string	El comprador es responsable de autorizar el pago	Sí
payment.nsu	string	Número secuencial único de transacción facilitado por el adquirente	Sí
payment.authCode	string	Código de autorización facilitado por el adquirente	No
payment.refundType	string	Tipo de devolución Valores posibles: ORIGEM – La devolución se hizo directamente al emisor de la tarjeta WALLET – Se ha realizado una devolución de cargo al monedero de iFood, en cuyo caso iFood cobrará al Comerciante, ya que recibirá el pago del emisor de la tarjeta.	Sí
payment.refundValue	string	Importe de la devolución	Sí
payment.refundDate	string	Fecha y hora de cancelación	Sí
payment.paymentDate	string	Fecha y hora del pago	No
payment.updatedAt	string	Fecha y hora de la última actualización del pago	No

Ejemplo:

[
  {
    "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

Informaciones generales

Campo	Tipo	Descripción	Nulo
merchantId	uuid	Identificador único del comerciante en la plataforma iFood	No
originPaymentId	string	Identificador original y único de la transferencia, presentado en la api de Pagos, antes de que la transferencia se divida a la entidad financiera.	No
paymentSplit	array	Separación hecha de la transferencia original, con las transferencias hechas a las instituciones financieras	No
id	string	Identificador único del registro de crédito	No
totalAmount	double	Importe total abonado a la entidad financiera	No
date	string	Fecha de registro del cobro	No
bankAccount.bankNumber	string	Número bancario de la transferencia	No
bankAccount.accountNumber	string	Número de cuenta del banco donde se realizó la transferencia	No
bankAccount.numberDigit	string	Dígito del número de cuenta del banco donde se realizó la transferencia	No
bankAccount.branchCode	string	Sucursal bancaria donde se realizó la transferencia	No
bankAccount.branchCodeDigit	string	Dígito de la sucursal bancaria donde se realizó la transferencia	No
type	string	Tipo de cuenta domiciliaria que recibió la transferencia del crédito	No
documentNumber	string	Número de identificación del comerciante (CNPJ/CPF)	No
documentHolderName	string	Número de identificación del comerciante (CNPJ/CPF)	No

Ejemplo:

[
  {
    "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

Informaciones generales

Campo	Tipo	Descrição	Nulo
orderId	uuid	Identificador único de pedido en la plataforma iFood	No
billedOrderId	uuid	Identificador único para la refacturación de pedidos	No
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	Sí
documentNumber	string	Número de identificación del comerciante (CNPJ/CPF)	No
orderDate	string	Fecha de creación del pedido en el formato YYYY-MM-DD	No
orderDateUpdate	string	Fecha de refactorización de la orden en el formato YYYY-MM-DD	No
orderDateTimeUpdate	string	Fecha y hora de refactorización de la orden en el formato YYYY-MM-DDTHH:MM:SS.ssssss-GMT	No
adjustmentAmount	double	Valor total de la refacturación del pedido, que puede ser positivo o negativo	No
expectedPaymentDate	string	Fecha prevista de transferencia al comerciante, en forma de YYYY-MM-DD	No
billedOrderUpdate.gmv	double	Valor total de la venta, incluidos los gastos de envío tras la refacturación.	No
billedOrderUpdate.totalBag	double	Valor total final de la cesta (productos/artículos) contenida en el pedido tras la refacturación.	No
billedOrderUpdate.deliveryFee	double	Importe de los gastos de envío cobrados al consumidor en el pedido	No
billedOrderUpdate.benefitIfood	double	Importe de la subvención financiera concedida por iFood en la solicitud	No
billedOrderUpdate.benefitMerchant	double	Importe de la subvención financiera concedida por el comerciante en la solicitud	No
billedOrderUpdate.commission	double	Importe de la comisión de pedido cobrada por iFood por intermediar en la venta	No
billedOrderUpdate.acquirerFee	double	Importe de la comisión cobrada por la operación de pago (pago in-app) del pedido.	No
billedOrderUpdate.deliveryCommission	double	Comisión cobrada cuando el modelo de negocio es ON_DEMAND, HYBRID ou HYBRID_REGION	No
billedOrderUpdate.commissionRate	double	Porcentaje de la comisión de intermediación de pedidos que iFood cobra al comerciante	No
billedOrderUpdate.acquirerFeeRate	double	Porcentaje de la comisión cobrada por la operación de pago relativa al pedido	No
billedOrderUpdate.totalDebit	double	Importe total cobrado por iFood por realizar el pedido, compuesto por comisión + tasas	No
billedOrderUpdate.totalCredit	double	Importe total al que tendría derecho el comerciante por el pedido, incluyendo el pago del consumidor y los beneficios concedidos por iFood por este pedido, para conocer el importe neto de la transferencia, el importe informado en este campo debe restarse del totalDebit.	No
billedOrderUpdate.anticipationFee	double	Calor del anticipo cobrado por el pedido según el plan de transferencia contratado.	No
billedOrderUpdate.anticipationFeeRate	double	Porcentaje del anticipo cobrado por el pedido	No
billedOrderUpdate.smallOrderFee	double	Valor total de todos los gastos cobrados al consumidor por iFood por realizar el pedido	No
displayId	string	Identificador de pedido corto de 4 dígitos, mismo valor que en el pedido y en el portal de socios. (ShortId)	Sí
cancellationCode	string	Código del motivo de cancelación según la tabla de política de cancelación de iFood	Sí
cancellationCodeDescription	string	Descripción del motivo de cancelación según la tabla de política de cancelación de iFood	Sí

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

Informaciones generales

Campo	Tipo	Descrição	Nulo
orderId	uuid	Identificador único de pedido en la plataforma iFood	No
displayId	string	Identificador de pedido corto de 4 dígitos, mismo valor que en el pedido y en el portal de socios. (ShortId)	Sí
orderDate	string	Fecha de creación del pedido en el formato YYYY-MM-DD	No
totalAmount	double	Importe bruto total del pago	No
taxPolAmount	double	Importe de la tasa cobrada por la transacción	No
netAmount	double	Importe neto total transferido al comerciante	No
merchantId	string	Identificador único del comerciante en la plataforma iFood	No
documentNumber	string	Número de identificación del comerciante (CNPJ/CPF)	No
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	Sí
expectedPaymentDate	string	Fecha prevista de transferencia al comerciante, en forma de YYYY-MM-DD	No

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

Informaciones generales

Campo	Tipo	Descrição	Nulo
orderId	uuid	Identificador único de pedido en la plataforma iFood	No
displayId	string	Identificador de pedido corto de 4 dígitos, mismo valor que en el pedido y en el portal de socios. (ShortId)	Sí
orderDate	string	Fecha de creación del pedido en el formato YYYY-MM-DD	No
totalAmount	double	pago bruto total después de la refacturación	No
taxPolAmount	double	Importe de la tasa cobrada por la transacción tras la refacturación	No
netAmount	double	valor neto total transferido al comerciante tras la refacturación	No
merchantId	string	Identificador único del comerciante en la plataforma iFood	No
documentNumber	string	Número de identificación del comerciante (CNPJ/CPF)	No
periodId	string	Identificador de agrupación. Se utiliza para vincular las contabilizaciones financieras a la transferencia realizada al comerciante	Sí
codeEvent	integer	código de evento para el ajuste del pedido	Sí
typeEvent	string	tipo do ajuste do pedido, podendo ser: ADJUSTMENT – Cuando hay un ajuste parcial del pedido (edición de uno o más artículos de la cesta) FULL_CANCELLATION – Cuando se cancelan todos los artículos del pedido.	Sí
adjustmentDate	string	fecha de creación de la refacturación del pedido, en el formato YYYY-MM-DD	No
expectedPaymentDate	string	Fecha prevista de transferencia al comerciante, en forma de YYYY-MM-DD	No

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"
  }
]