iFood para Entregadores — private driver-finance data API

iFood para Entregadores is the courier companion app for Brazil's largest food-delivery network. Behind its earnings screens sits a courier finance API that exposes everything a driver earns and is paid: consolidated payout batches, per-payout details, weekly billing-entry earnings, the driver's current balance and payment list, configurable earnings goals, and a receivables-anticipation (early-payment) product with per-plan fees, min/max amounts and request counters. All of it is gated by an OAuth2-style token grant that issues access/refresh tokens scoped to a driverId.

Screenshots

API surface

• OAuth2 driver token grant

  POST /v1/identity/session openfinance

  Authenticates a courier (password / otp / biometric / refresh grants) and returns the Bearer token plus driverId used by every other finance endpoint.

  Auth: None (issues tokens). Form-encoded body; device and installation headers identify the courier's handset.

  • accessToken
  • tokenType
  • refreshToken
  • expiresIn
  • userUuid
  • tenant
  • driverId
  • challengeType
  • factors

  Illustrative example reconstructed from the app's interface — not a live capture.

  POST /v1/identity/session HTTP/1.1
  Content-Type: application/x-www-form-urlencoded
  X-Device-Id: 3f2b8c1d-9a1e-4c2b
  X-Installation-Id: 7a91f0e2-55c1
  
  application=driver-app&username=11987654321&password=******

  {
    "accessToken": "eyJhbGciOi...",
    "tokenType": "Bearer",
    "refreshToken": "d8f1c2...",
    "expiresIn": 3600,
    "userUuid": "9b0e12f4-...",
    "tenant": "IFood",
    "driverId": "a41c9e02-..."
  }

  Derived from the app's interface; endpoint details are illustrative, not a live capture.

  • reconstructed from the app's courier sign-in and session flow
  • matches the token payload consumed by every earnings screen

• List consolidated payouts

  GET /v1/payouts/history openfinance

  Returns the driver's consolidated payout history (summary + list) for a period, payment type and page — the core 'Meus Repasses' feed.

  Auth: Bearer accessToken from /v1/identity/session

  • id
  • paymentDate
  • period
  • paymentTime
  • paymentType
  • status
  • amount
  • feeAmount
  • summary
  • data

  Illustrative example reconstructed from the app's interface — not a live capture.

  GET /v1/payouts/history?period=2026-08&paymentType=WEEKLY&page=0&size=20 HTTP/1.1
  Authorization: Bearer eyJhbGciOi...

  {
    "summary": {"id": "sum", "paymentDate": "2026-08-31", "paymentType": "WEEKLY", "status": "PAID", "amount": 128540, "feeAmount": 0},
    "data": [
      {"id": "pay_01H...", "paymentDate": "2026-08-24", "period": {"start": "2026-08-18", "end": "2026-08-24"}, "paymentTime": "14:02:11", "paymentType": "WEEKLY", "status": "PAID", "amount": 64210, "feeAmount": 0}
    ]
  }

  Derived from the app's interface; endpoint details are illustrative, not a live capture.

  • reconstructed from the app's payout history ('Meus Repasses') flow
  • consistent with the period/paymentType filters on the payouts screen

• Get payout detail

  GET /v1/payouts/{payoutId} openfinance

  Reads a single payout's full detail (amount, fee, period, status) for the payout-detail screen.

  Auth: Bearer accessToken from /v1/identity/session

  • id
  • paymentDate
  • period
  • paymentTime
  • paymentType
  • status
  • amount
  • feeAmount

  Illustrative example reconstructed from the app's interface — not a live capture.

  GET /v1/payouts/pay_01H... HTTP/1.1
  Authorization: Bearer eyJhbGciOi...

  {
    "id": "pay_01H...",
    "paymentDate": "2026-08-24",
    "period": {"start": "2026-08-18", "end": "2026-08-24"},
    "paymentTime": "14:02:11",
    "paymentType": "WEEKLY",
    "status": "PAID",
    "amount": 64210,
    "feeAmount": 0
  }

  Derived from the app's interface; endpoint details are illustrative, not a live capture.

  • reconstructed from the app's payout detail screen

• Get billing-entry earnings summary

  GET /v1/earnings/summary openfinance

  Aggregates the driver's per-delivery billing entries into an earnings total over a date range.

  Auth: Bearer accessToken from /v1/identity/session

  • weeklyAmount
  • weeklyEarnings
  • amount
  • date

  Illustrative example reconstructed from the app's interface — not a live capture.

  GET /v1/earnings/summary?startDate=2026-08-01&endDate=2026-08-31 HTTP/1.1
  Authorization: Bearer eyJhbGciOi...

  {
    "weeklyAmount": 128540,
    "weeklyEarnings": [
      {"date": "2026-08-24", "amount": 64210, "entriesCount": 31}
    ]
  }

  Derived from the app's interface; endpoint details are illustrative, not a live capture.

  • reconstructed from the app's weekly earnings flow
  • matches the date-range totals shown on the earnings screen

• Get balance and payments

  GET /v1/wallet openfinance

  Reads the courier's current balance / payments list together with the registered Brazilian payout bank account.

  Auth: Bearer accessToken from /v1/identity/session

  • balance
  • accountType
  • accountNumber
  • accountDigit
  • branchNumber
  • bankCode
  • bankName
  • ownerDocument

  Illustrative example reconstructed from the app's interface — not a live capture.

  GET /v1/wallet HTTP/1.1
  Authorization: Bearer eyJhbGciOi...

  {
    "balance": {"available": 81240, "pending": 17300},
    "bankAccount": {"accountType": "CHECKING", "accountNumber": "00123456", "accountDigit": "7", "branchNumber": "0001", "bankCode": "341", "bankName": "Itaú", "ownerDocument": "123.***.***-45"}
  }

  Derived from the app's interface; endpoint details are illustrative, not a live capture.

  • reconstructed from the app's balance and bank-account flow

• Get receivables anticipation plan

  GET /v1/advance-pay/plan openfinance

  Exposes the driver's early-payment (receivables anticipation) plan: fee, min/max amounts, frequency, and daily/monthly request counters. Failures map to a small set of payment error codes.

  Auth: Bearer accessToken from /v1/identity/session

  • name
  • feeAmount
  • minAmount
  • maxAmount
  • paymentFrequency
  • requested
  • available

  Illustrative example reconstructed from the app's interface — not a live capture.

  GET /v1/advance-pay/plan HTTP/1.1
  Authorization: Bearer eyJhbGciOi...

  {
    "name": "Antecipação Semanal",
    "feeAmount": 199,
    "minAmount": 5000,
    "maxAmount": 250000,
    "paymentFrequency": "WEEKLY",
    "requested": {"count": 1},
    "available": {"count": 3}
  }

  Derived from the app's interface; endpoint details are illustrative, not a live capture.

  • reconstructed from the app's early-payment offer flow
  • consistent with the fee and limit copy on the anticipation screen

Data categories

• payouts
• earnings
• balances
• payments
• bank-accounts
• receivables-anticipation
• auth-tokens

Where teams use this data

• Gig-work payout reconciliation

  Accounting tools pull the consolidated payout history and per-payout detail nightly, matching payment dates, amounts and fee amounts against bank statements so a courier's books close themselves.

• Fleet earnings dashboards

  Fleet operators aggregate the weekly earnings summary across their drivers — weekly amounts, billing entries and daily breakdowns — to rank productivity and forecast cash-out for the week.

• Receivables anticipation offers

  Lending products read the advance-pay plan (fee, min/max amount, payment frequency) together with the wallet balance to pre-approve drivers for early payout on their receivables.

Frequently asked questions

Related apps

• LinkedIn: Community & Network
• PDF Scanner app - TapScanner
• Porter Driver Partner App
• hh: поиск работы
• InfoJobs - Job Search

Topics

• ifood driver api
• ifood entregador api
• ifood payouts endpoint
• ifood driver earnings api
• ifood bank account api
• ifood courier api
• ifood early payment api