Flash Benefícios private data API
Flash | Benefícios e Despesas is the employee app from Flash Tecnologia (the São Paulo benefits-and-spend company behind the Flash card, Clube Flash and Flash OS). After a CPF sign-in, the home wallets list every purse the employer loaded — meal, food, mobility, health and incentive — next to a physical or virtual corporate card that provisions into Google Pay, Samsung Pay or Apple Wallet. From those balances workers pay PIX and TED, recharge vale-transporte (SPTrans Bilhete Único and other city issuers), buy Clube Flash vouchers, submit GPS-tagged expense reports with receipt capture, request cash advances, punch Folha Certa time clocks, and open payroll-credit or FGTS-anniversary products. The app is published for Brazil, where it competes for the same PAT and corporate-spend seats as Alelo, Pluxee Brasil, VR Benefícios, Ticket (Edenred) and Caju.
PAT purses and expense lines share the signed-in employee record: a benefit exposes balance beside flashCategories, and each expense line carries value, currencyPrefix and the paying card's lastFourDigits.
Report rows add remainingReimbursement and advancesValue; a statement reclassification preview contrasts currentDebitData.balance with previewDebitData.isCorporateCard before the debit moves. PIX cash-out returns pixKey and balanceAfter; TED carries bankCode, branchCode and accountNumber; vale-transporte cards list issuerName and number.
Payroll teams reconcile PAT deposits against purse balances, finance stacks ingest reports into the ledger, and treasury watches corporate-card flashCategory totals. openData Studio turns those fields into callable open data.
Screenshots
API surface
The endpoints and request/response examples below are reconstructed from the app's interface — illustrative, not a live capture.
Employee benefits and card categories
POST
/v1/wallet/benefits/lookupopenfinanceLoads the signed-in employee's benefit purses (meal, food, mobility, health) and the corporate-card category keys used on the home wallets.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- employeeId
- _id
- benefits
- name
- key
- flashCategories
- creditCard
- balance
POST /v1/wallet/benefits/lookup HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 X-App-Version: 6.24.0 Content-Type: application/json { "employeeId": "emp_10482" }{ "employeeId": "emp_10482", "benefits": [ { "_id": "ben_refeicao", "name": "Flash Refeição", "key": "MEAL", "flashCategories": [ { "key": "meal" } ], "balance": 842.5 } ], "creditCard": { "flashCategories": [ { "key": "corporate" } ] } }Marketplace product for a benefit purse
POST
/v1/marketplace/offers/resolveopendataReturns a Clube Flash catalog item, which benefit purses may pay for it, and the priced subproducts shown on the buy sheet.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- productId
- benefitsIds
- flashCategory
- offerType
- allowedBenefits
- subproducts
- price
- discountRate
- expirationDate
POST /v1/marketplace/offers/resolve HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 Content-Type: application/json { "productId": "prd_clube_gift", "benefitsIds": [ "ben_refeicao" ] }{ "productId": "prd_clube_gift", "name": "Vale presente", "nickname": "Gift", "status": "ACTIVE", "flashCategory": "convenience", "offerType": "VOUCHER", "allowedBenefits": [ { "_id": "ben_refeicao", "name": "Flash Refeição", "key": "MEAL" } ], "subproducts": [ { "_id": "sub_50", "name": "R$ 50", "price": 50.0, "discountRate": 0, "expirationDate": "2026-12-31" } ] }List expenses
POST
/v1/spend/entries/searchopenfinancePages the worker's expense lines — amount, merchant, category, paying card and GPS capture flag — for the Despesas inbox.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- id
- status
- value
- currencyPrefix
- expenseDate
- type
- cardId
- lastFourDigits
- category
- establishment
- gpsStatus
- total
- currentPage
- pages
POST /v1/spend/entries/search HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 Content-Type: application/json { "page": 1, "limit": 20, "hasPending": true, "onlyWithViolations": false }{ "expenses": [ { "id": 881203, "status": "PENDING", "value": 87.4, "currencyPrefix": "R$", "expenseDate": "2026-10-12", "type": "CARD", "cardId": "crd_corp_19", "card": { "lastFourDigits": "4412" }, "category": { "id": 14, "description": "Alimentação" }, "establishment": { "place": "Padaria São Paulo" }, "gpsStatus": "CAPTURED" } ], "total": 36, "currentPage": 1, "pages": 2 }Create expense
POST
/v1/spend/entries/createopenfinanceCreates an expense line from the register screen (manual, card, or OCR receipt) and returns the new id plus GPS/merchant snapshot.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- value
- expenseDate
- categoryId
- costCenterId
- projectId
- paymentMethodId
- placeId
- lat
- lng
- referenceId
- gpsStatus
POST /v1/spend/entries/create HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 Content-Type: application/json { "value": 87.4, "expenseDate": "2026-10-12", "categoryId": 14, "costCenterId": 3, "projectId": 9, "paymentMethodId": 2, "establishment": { "placeId": "plc_01", "place": "Padaria São Paulo", "lat": -23.561, "lng": -46.656 } }{ "id": 881203, "status": "DRAFT", "value": 87.4, "currencyPrefix": "R$", "referenceId": "EXP-881203", "gpsStatus": "CAPTURED", "establishment": { "place": "Padaria São Paulo", "lat": -23.561, "lng": -46.656 } }List expense reports
POST
/v1/spend/reports/searchopenfinancePages expense reports with reimbursable vs advance totals and the current approver, matching the Relatórios screen.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- id
- name
- referenceId
- status
- value
- currencyPrefix
- submittedAt
- remainingReimbursement
- reimbursableValue
- advancesValue
- approver
POST /v1/spend/reports/search HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 Content-Type: application/json { "page": 1, "limit": 10, "onlyWithPendencies": true }{ "reports": [ { "id": 22011, "name": "Viagem SP out/26", "referenceId": "RPT-22011", "status": "SUBMITTED", "value": 1240.0, "currencyPrefix": "R$", "submittedAt": "2026-10-14T18:02:11Z", "remainingReimbursement": 190.0, "reimbursableValue": 1050.0, "advancesValue": 400.0, "approver": { "name": "Marina Costa" } } ], "total": 4, "currentPage": 1, "pages": 1 }List cash advances
POST
/v1/spend/prepayments/searchopenfinanceLists cash advances that can be attached to a report, with amount, status and assigned approver.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- id
- referenceId
- status
- advanceDate
- value
- currencyCode
- currencyPrefix
- approver
- report
POST /v1/spend/prepayments/search HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 Content-Type: application/json { "page": 1, "limit": 20, "isOpenToAttach": true }{ "advances": [ { "id": 5502, "referenceId": "ADV-5502", "status": "APPROVED", "advanceDate": "2026-10-01", "value": 400.0, "currencyCode": "BRL", "currencyPrefix": "R$", "approver": { "id": 88, "name": "Marina Costa" }, "report": { "id": 22011, "name": "Viagem SP out/26", "referenceId": "RPT-22011" } } ], "total": 1, "currentPage": 1, "pages": 1 }TED transfer from a benefit purse
POST
/v1/wallet/transfers/bankopenbankingSends a TED out of a named benefit purse to a Brazilian bank account; empty errors means the transfer was accepted.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- employeeId
- benefitId
- amount
- bankCode
- branchCode
- accountNumber
- errors
- field
- message
- code
POST /v1/wallet/transfers/bank HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 X-Device-Fingerprint: dev_9aa1 Content-Type: application/json { "employeeId": "emp_10482", "benefitId": "ben_refeicao", "amount": 200.0, "bankCode": "001", "branchCode": "3410", "accountNumber": "12345-6" }{ "errors": [] }Person transport cards
POST
/v1/commute/cards/listopenfinanceReturns the worker's CPF-linked vale-transporte cards (issuer, city and card number) used by the recarga flow.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- _id
- cpf
- transportCards
- name
- number
- cityId
- cityName
- issuerId
- issuerName
POST /v1/commute/cards/list HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 Content-Type: application/json {}{ "_id": "per_771", "cpf": "12345678901", "transportCards": [ { "name": "Bilhete Único", "number": "0012345678", "cityId": "sp", "cityName": "São Paulo", "issuerId": "sptrans", "issuerName": "SPTrans" } ] }Buy transport recharge
POST
/v1/commute/topups/purchaseopenbankingPurchases a vale-transporte top-up against a benefit purse and returns rechargeId plus ticketTransactionId.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- cardNumber
- issuerId
- cityId
- benefitId
- amount
- rechargeId
- rechargeStatus
- ticketTransactionId
POST /v1/commute/topups/purchase HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 X-App-Version: 6.24.0 X-Device-Fingerprint: dev_9aa1 Content-Type: application/json { "cardNumber": "0012345678", "issuerId": "sptrans", "cityId": "sp", "benefitId": "ben_vt", "amount": 50.0 }{ "rechargeId": "rch_9981", "rechargeStatus": "CONFIRMED", "ticketTransactionId": "txn_vt_441", "errors": [] }Statement reclassification preview
POST
/v1/ledger/reassignments/previewopenfinancePreviews moving a statement debit from a benefit purse onto the corporate card (or the reverse) before the move is confirmed.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- employeeId
- transactionId
- currentDebitData
- previewDebitData
- amount
- balance
- isCorporateCard
- name
POST /v1/ledger/reassignments/preview HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 Content-Type: application/json { "employeeId": "emp_10482", "transactionId": "txn_cc_19" }{ "currentDebitData": { "amount": 87.4, "balance": 842.5, "isCorporateCard": false, "name": "Flash Refeição" }, "previewDebitData": { "amount": 87.4, "balance": 1910.0, "isCorporateCard": true, "name": "Cartão corporativo" }, "error": null }Spend chart by Flash category
POST
/v1/insights/spend/by-categoryopendataReturns per-category spend totals on the corporate card for the statement insights chart.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- employeeId
- creditCard
- flashCategories
- name
- key
- summaryByEmployee
- total
- flashCategory
POST /v1/insights/spend/by-category HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 Content-Type: application/json { "employeeId": "emp_10482" }{ "employeeId": "emp_10482", "creditCard": { "flashCategories": [ { "name": "Alimentação", "image": "meal.png", "description": "Refeições", "key": "meal" } ], "summaryByEmployee": [ { "total": 1240.55, "flashCategory": "meal" } ] } }Physical corporate card details
GET
/v1/cards/corporate/faceopenbankingReads the physical corporate-card face shown in the wallet (last four, expiry, international flag) after the user picks a card.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- financeCardId
- lastFourDigits
- status
- holderName
- expiryMonth
- expiryYear
- cardType
- internationalEnabled
GET /v1/cards/corporate/face?financeCardId=crd_corp_19 HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 X-App-Version: 6.24.0{ "financeCardId": "crd_corp_19", "lastFourDigits": "4412", "status": "ACTIVE", "holderName": "ANA SOUZA", "expiryMonth": 12, "expiryYear": 28, "cardType": "PHYSICAL", "internationalEnabled": false }PIX cash-out preview
POST
/v1/wallet/instant-transfers/quoteopenbankingPreviews a PIX cash-out from a benefit purse (recipient, fee, balanceAfter) before the confirm step.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- pixKey
- amount
- benefitId
- recipientName
- fee
- benefitName
- balanceAfter
POST /v1/wallet/instant-transfers/quote HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 X-Device-Fingerprint: dev_9aa1 Content-Type: application/json { "pixKey": "[email protected]", "amount": 75.0, "benefitId": "ben_refeicao" }{ "recipientName": "ANA SOUZA", "pixKey": "[email protected]", "amount": 75.0, "fee": 0, "benefitId": "ben_refeicao", "benefitName": "Flash Refeição", "balanceAfter": 767.5 }Card statement list
GET
/v1/cards/entriesopenbankingPages corporate-card and benefit-card statement lines for the Extrato screen.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- financeCardId
- transactionId
- amount
- currency
- merchantName
- flashCategory
- postedAt
- isCorporateCard
- lastFourDigits
- hasMore
GET /v1/cards/entries?financeCardId=crd_corp_19&page=1 HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21{ "items": [ { "transactionId": "txn_cc_19", "amount": 87.4, "currency": "BRL", "merchantName": "Padaria São Paulo", "flashCategory": "meal", "postedAt": "2026-10-12T12:41:00Z", "isCorporateCard": true, "lastFourDigits": "4412" } ], "page": 1, "hasMore": true }Create reimbursement
POST
/v1/spend/out-of-pocket/createopenfinanceCreates an out-of-pocket reimbursement (merchant, category, justification) that later lands on a report.
Auth: Session token header plus a company-scope header; money-movement calls also send an app-version header and a device-fingerprint header.
- amount
- date
- establishmentName
- category
- justification
- additionalCommentary
- id
POST /v1/spend/out-of-pocket/create HTTP/1.1 X-Session-Token: <session> X-Company-Id: cmp_8f21 Content-Type: application/json { "amount": 120.0, "date": "2026-10-11", "establishmentName": "Farmácia Droga Raia", "category": "health", "justification": "Medicamento durante viagem", "additionalCommentary": "Receita anexa" }{ "id": "rmb_331", "amount": 120.0, "date": "2026-10-11", "establishmentName": "Farmácia Droga Raia", "category": "health", "justification": "Medicamento durante viagem", "additionalCommentary": "Receita anexa" }
Data categories
- benefit balances
- expense reports
- cash advances
- TED transfers
- PIX payments
- transport cards
- corporate cards
- card statements
- reimbursements
- spend categories
Where teams use this data
Payroll-cycle benefit reconciliation
HRIS bots pull each employee's benefits[].balance, key and flashCategories after payday and flag purses whose remaining balance does not match the PAT deposit file.
Expense-report ingest into ERP
Finance integrations page the expense-report list for remainingReimbursement and advancesValue, then walk each expense line (value, lastFourDigits, establishment.place, costCenter) into the general ledger.
Corporate-card spend monitor
Treasury dashboards combine the card statement list with per-flashCategory spend totals and alert when isCorporateCard spend jumps versus the meal purse.
PIX and TED outflow audit
Compliance tools replay the PIX preview (pixKey, balanceAfter) and bank-transfer inputs (bankCode, branchCode, accountNumber) against the anti-fraud device id attached to the session.
Frequently asked questions
What balances does Flash expose for an employee?
Each benefit purse on the employee record has a balance plus a key and flashCategories (meal, food, mobility, health). Corporate-card spend is summarized per flashCategory, and a PIX preview returns balanceAfter on the purse that will pay.
How do expense reports relate to advances?
A report carries remainingReimbursement, reimbursableValue and advancesValue. Advances themselves have advanceDate, value, currencyCode and an approver, and can be attached to a report by referenceId.
Can I see PIX and TED counterparts?
Yes. PIX preview returns pixKey, recipientName, fee and balanceAfter. A TED request accepts bankCode, branchCode and accountNumber and returns field-level errors when the destination is rejected.
How does the app authenticate these calls?
After CPF sign-in the client sends a session token and a company-scope header on every call. Cash-out and card routes also attach an app-version header and a device-fingerprint header.
Apps similar to Flash | Benefícios e Despesas
- Meu Alelo — Alelo issues Brazilian PAT meal, food, culture and transport benefit cards, and the Meu Alelo app is used for QR payments, Google Pay and Apple Pay wallets, and card management.
- Pluxee Brasil — Pluxee Brasil, formerly Sodexo Benefícios e Incentivos, is the cardholder app for Pluxee meal, food, culture, gift and fuel cards, including a Multibenefícios card with up to seven wallets.
- SuperApp VR — SuperApp VR is VR Benefícios' worker app for VR Multi meal, food, home-office, auto and prize balances, plus payments with a QR code or virtual card.
- Ticket — Ticket is Edenred's Brazilian employee-benefits brand for Ticket Restaurante, Alimentação, Flex, Transporte and Cultura cards, managed in the official Ticket app.
- Caju — Caju is a Brazilian benefits-and-spend platform that puts CLT, PAT and flexible-benefit balances plus reimbursements and advances on one Visa-accepted card and employee app.
- iFood Benefícios — iFood Benefícios is a PAT multi-balance card for meal, mobility, culture, health, education and home-office stipends that can be spent in the iFood app and at Elo-affiliated merchants.
- Swile Brasil — Swile Brasil is a PAT-registered multi-benefit Mastercard that puts meal, food, health, mobility, home-office, education, fuel and award wallets on one card, with a worker app and Dash RH.
Topics
- flash beneficios api
- flash despesas
- flash corporate card
- vale refeicao flash
- flash pix ted
- flash sptrans
- employee benefit balance brazil
- expense report remainingReimbursement
Need this app's data API integrated?
We deliver scoped integrations for any named app — from USD 500 with source-code handoff, or hosted access billed per call. Tell us the data you need.
- NDA + SOW on every engagement
- Delivery in 3–7 days
- Payment only after acceptance
- Work scoped to authorized use