API Anticipation

Sobre Antecipação de Pagamentos

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

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

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

Entendendo os lançamentos financeiros