API Settlements

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
originDetails	Histórico dos itens que compõe o fechamento do período

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

Esta página foi útil?

Avalie sua experiência no novo Developer portal:

Nesta página

API Settlements

Principais campos

Descrição de todos campos

Casos de uso

Conteúdo lido0%