Meu Alelo 福利钱包数据 API
Meu Alelo 是 Alelo 官方的持卡人应用。Alelo 是巴西的员工福利发卡机构,提供受 PAT 约束的餐券与食品券,以及文化、出行、激励和多福利实体卡。用户凭 CPF 通过密码、OwnID 通行密钥或多重验证(MFA)登录后,首页轮播会列出该员工持有的每一个钱包——Alelo Refeição、Alelo Alimentação、Alelo Cultura、Alelo Mobilidade、Alelo Multibenefícios、Alelo Pod、Alelo Tudo、Natal、Incentivo/Premiação、Pagamentos 以及 vale-transporte——并支持解锁、修改 PIN、挂失或被盗冻结、卡片物流追踪,以及面向外卖应用的虚拟卡卡面。支付区域支持 Elo QR、TED、非接触感应支付、boleto 和 Google Pay;同一会话还能进入药房折扣(ePharma)、健康套餐、专属优惠、Veloe 通行标签、AppGas、Pede Pronto 外卖支付、Rende Mais 收益、Digio 的 FGTS 周年贷款,以及受理网络地图。该应用仅在巴西上架,Google Play 评分 4.8,共 157 万条评价,安装量超过 1000 万,与 Pluxee Brasil、VR Benefícios、Ticket(Edenred Brasil)、Caju 和 Flash Benefícios 争夺同一批 PAT 钱包。
PAT 钱包条目同时带有 availableBalance 与 blockedBalance,并以 benefitType(ALIMENTACAO、REFEICAO、MOBILIDADE、CULTURA、NATAL、MULTIBENEFICIOS、POD、PAGAMENTOS、INCENTIVO)标记,另有 last4Digits 和 cardStatus。对账单条目增加了 statementType,取值如 MAINTENANCE_FEE_PAT、INACTIVITY_FEE_PAT、BLOCKED_BALANCE 与 RETURN_BENEFIT;消费记录以 transactionId 落地,带 merchantName 和 APPROVED/DENIED 的 status。
TED 载荷使用 bankCode、agency 与 feeAmount;boleto 先校验 typedLine,再从所选卡扣款;Elo QR 与 Natal 虚拟卡会生成 virtualCardId / panLast4。工资单对账、费用分析和丢卡处理台都在使用这些字段——openData Studio 把它们变成可调用的开放数据。
应用截图
API 端点一览
请求/响应示例为依据应用界面重构的示意示例,并非实时抓包。
预付卡登录鉴权
POST
/v1/auth/prepaid/tokenopendata用 CPF 凭证(或通行密钥 / MFA 验证)换取预付卡访问令牌,之后每一次钱包调用都靠它。
认证方式: 无需令牌。凭 CPF 加密码、OwnID 通行密钥或 MFA 一次性验证码换取 accessToken;之后的调用携带 Authorization: Bearer。
- cpf
- password
- deviceId
- loginChannel
- accessToken
- refreshToken
- tokenType
- expiresIn
- mfaRequired
- userId
POST /v1/auth/prepaid/token HTTP/1.1 Content-Type: application/json { "cpf": "12345678901", "password": "********", "deviceId": "a1b2c3d4-e5f6", "loginChannel": "PASSWORD" }{ "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid", "refreshToken": "rt_alelo_9f21", "tokenType": "Bearer", "expiresIn": 3600, "mfaRequired": false, "userId": "USR-88412019" }当前持卡人资料
GET
/v1/users/meosint返回已登录持卡人的姓名、CPF、邮箱、手机号与常驻州,用于资料页和联系方式更新页。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌。
- userId
- fullName
- cpf
- phone
- preferredState
- lgpdAccepted
GET /v1/users/me HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid{ "userId": "USR-88412019", "fullName": "Ana Souza", "cpf": "12345678901", "email": "[email protected]", "phone": "11987654321", "preferredState": "SP", "lgpdAccepted": true }福利卡列表与余额
GET
/v1/cardsopenfinance列出首页轮播里的每个 PAT 与预付钱包,含 productName、benefitType、availableBalance、blockedBalance 与 Natal 专用余额。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌。
- cardId
- productName
- benefitType
- last4Digits
- availableBalance
- blockedBalance
- natalBalance
- currency
- cardStatus
- isVirtual
- isContactlessEnabled
- expiryDate
GET /v1/cards HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid{ "cards": [ { "cardId": "CRD-POD-100284", "productName": "Alelo Pod", "benefitType": "POD", "last4Digits": "4419", "availableBalance": 842.35, "blockedBalance": 0.0, "natalBalance": 120.00, "currency": "BRL", "cardStatus": "ACTIVE", "isVirtual": false, "isContactlessEnabled": true, "expiryDate": "2028-08" }, { "cardId": "CRD-ALI-552001", "productName": "Alelo Alimentação", "benefitType": "ALIMENTACAO", "last4Digits": "1182", "availableBalance": 610.40, "blockedBalance": 50.00, "natalBalance": 0.0, "currency": "BRL", "cardStatus": "ACTIVE", "isVirtual": false, "isContactlessEnabled": true, "expiryDate": "2027-11" } ] }卡片对账单
GET
/v1/cards/{cardId}/statementopenbanking返回某张卡的对账单条目,含 PAT 维护费 / 闲置费、司法冻结的 blockedBalance 变动,以及 RETURN_BENEFIT 追回。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌。
- cardId
- from
- to
- statementId
- postingDate
- amount
- currency
- statementType
- description
- benefitType
GET /v1/cards/CRD-POD-100284/statement?from=2026-09-01&to=2026-10-16 HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid{ "cardId": "CRD-POD-100284", "from": "2026-09-01", "to": "2026-10-16", "entries": [ { "statementId": "STM-991002", "postingDate": "2026-10-05", "amount": -12.90, "currency": "BRL", "statementType": "MAINTENANCE_FEE_PAT", "description": "Tarifa de manutenção PAT", "benefitType": "REFEICAO" }, { "statementId": "STM-991088", "postingDate": "2026-10-12", "amount": -50.00, "currency": "BRL", "statementType": "BLOCKED_BALANCE", "description": "Bloqueio judicial", "benefitType": "ALIMENTACAO" } ] }卡片交易记录
GET
/v1/cards/{cardId}/transactionsopenbanking分页返回钱包的消费记录,含 merchantName、MCC、amount 与 APPROVED/DENIED 状态,供账单页(extrato)和消费详情页使用。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌。
- cardId
- transactionId
- merchantName
- mcc
- amount
- currency
- status
- authorizationCode
- benefitType
- occurredAt
GET /v1/cards/CRD-POD-100284/transactions?page=0&size=20 HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid{ "cardId": "CRD-POD-100284", "page": 0, "size": 20, "items": [ { "transactionId": "TXN-44019283", "merchantName": "Padaria São João", "mcc": "5411", "amount": 32.70, "currency": "BRL", "status": "APPROVED", "authorizationCode": "884201", "benefitType": "REFEICAO", "occurredAt": "2026-10-16T12:04:11-03:00" }, { "transactionId": "TXN-44019301", "merchantName": "Posto Veloe", "mcc": "5541", "amount": 80.00, "currency": "BRL", "status": "DENIED", "authorizationCode": null, "benefitType": "MOBILIDADE", "occurredAt": "2026-10-16T08:11:02-03:00" } ] }校验 boleto 条码
POST
/v1/payments/barcode/validateopenfinance在缴费确认页之前,把扫码或手输的 boleto 线性码(linha digitável)解码为 beneficiaryName、documentAmount 与 dueDate。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌。
- barcode
- typedLine
- valid
- beneficiaryName
- documentAmount
- dueDate
- currency
POST /v1/payments/barcode/validate HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid Content-Type: application/json { "barcode": "23793381286000000003300000000123456789012000", "typedLine": "23793.38128 60000.000003 30000.000001 2 34567890120000" }{ "valid": true, "beneficiaryName": "Companhia de Saneamento", "documentAmount": 189.40, "dueDate": "2026-10-25", "barcode": "23793381286000000003300000000123456789012000", "typedLine": "23793.38128 60000.000003 30000.000001 2 34567890120000", "currency": "BRL" }用所选卡支付 boleto
POST
/v1/paymentsopenfinance从所选的 Pagamentos / 激励 / Pod 卡扣款支付 boleto,返回 paymentId、receiptId 与 APPROVED 状态。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌;安全模块要求在设备上输入卡片 PIN 或使用生物识别。
- cardId
- paymentType
- barcode
- amount
- currency
- paymentId
- status
- receiptId
- paidAt
POST /v1/payments HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid Content-Type: application/json { "cardId": "CRD-PAG-330011", "paymentType": "PAYMENT", "barcode": "23793381286000000003300000000123456789012000", "amount": 189.40, "currency": "BRL" }{ "paymentId": "PAY-220198", "cardId": "CRD-PAG-330011", "paymentType": "PAYMENT", "amount": 189.40, "currency": "BRL", "status": "APPROVED", "receiptId": "RCT-88012", "paidAt": "2026-10-16T09:41:03-03:00" }创建 TED 转账
POST
/v1/transfersopenbanking把 Alelo Pagamentos / 激励 / Pod 钱包里的钱以 TED 转到巴西银行账户,返回 tedId、feeAmount 与处理状态。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌;安全模块要求 PIN 或生物识别。手续费先通过转账费用服务报价。
- cardId
- bankCode
- agency
- accountNumber
- accountType
- beneficiaryName
- beneficiaryCpf
- amount
- currency
- transferPurpose
- tedId
- feeAmount
- status
- scheduledAt
POST /v1/transfers HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid Content-Type: application/json { "cardId": "CRD-PAG-330011", "bankCode": "237", "agency": "1234", "accountNumber": "0056789-0", "accountType": "CHECKING", "beneficiaryName": "Carlos Lima", "beneficiaryCpf": "98765432100", "amount": 250.00, "currency": "BRL", "transferPurpose": "TED" }{ "tedId": "TED-441009", "cardId": "CRD-PAG-330011", "amount": 250.00, "feeAmount": 8.50, "currency": "BRL", "status": "PROCESSING", "bankCode": "237", "agency": "1234", "accountNumber": "0056789-0", "scheduledAt": "2026-10-16T10:02:44-03:00" }签发虚拟卡
POST
/v1/cards/{cardId}/virtual-cardsopenfinance针对一张实体卡生成虚拟卡号(含面向外卖应用的 Natal 专用 VCN),返回 panLast4、有效期与 natalBalance。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌;在虚拟卡密码页输入卡片密码。
- cardId
- purpose
- wallet
- virtualCardId
- panLast4
- expiryMonth
- expiryYear
- cvvToken
- status
- natalBalance
- currency
POST /v1/cards/CRD-POD-100284/virtual-cards HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid Content-Type: application/json { "cardId": "CRD-POD-100284", "purpose": "NATAL_DELIVERY", "wallet": "APP" }{ "virtualCardId": "VCN-778201", "cardId": "CRD-POD-100284", "panLast4": "9021", "expiryMonth": 8, "expiryYear": 2028, "cvvToken": "cvv_tok_9a", "status": "ACTIVE", "purpose": "NATAL_DELIVERY", "natalBalance": 120.00, "currency": "BRL" }解锁卡片
POST
/v1/cards/{cardId}/unlockopenfinance持卡人确认卡片密码后,激活新发或此前被冻结的实体卡。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌;在解锁步骤页输入卡片密码。
- cardId
- cardPassword
- unlockReason
- cardStatus
- unlockedAt
POST /v1/cards/CRD-ALI-552001/unlock HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid Content-Type: application/json { "cardId": "CRD-ALI-552001", "cardPassword": "****", "unlockReason": "NEW_PLASTIC" }{ "cardId": "CRD-ALI-552001", "cardStatus": "ACTIVE", "unlockedAt": "2026-10-16T11:18:09-03:00", "unlockReason": "NEW_PLASTIC" }Elo QR 扫码支付
POST
/v1/payments/qropenfinance虚拟卡创建并解锁后,用所选 Pod / PAT 钱包支付商户二维码(启用时走 Elo QR)。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌;需要 QR 安全模块,并且 Alelo Pod 上已有解锁的虚拟卡。
- cardId
- virtualCardId
- paymentKey
- qrPayload
- amount
- currency
- eloQrEnabled
- paymentId
- status
- scheme
- paidAt
POST /v1/payments/qr HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid Content-Type: application/json { "cardId": "CRD-POD-100284", "virtualCardId": "VCN-778201", "paymentKey": "QRPAYMENT", "qrPayload": "00020126580014br.gov.bcb.pix...", "amount": 54.90, "currency": "BRL", "eloQrEnabled": true }{ "paymentId": "PAY-QR-33012", "cardId": "CRD-POD-100284", "virtualCardId": "VCN-778201", "paymentKey": "QRPAYMENT", "amount": 54.90, "currency": "BRL", "status": "APPROVED", "scheme": "ELO", "paidAt": "2026-10-16T12:22:05-03:00" }Pod 钱包间余额划转
POST
/v1/cards/balance-transfersopenfinance在 Alelo Pod 的餐券与食品券钱包(及类似的多钱包产品)之间划转金额,并返回划出与划入两侧的 availableBalance。
认证方式: 携带 /v1/auth/prepaid/token 返回的 Bearer 令牌;在 fragment_balance_transfer_password 页输入卡片密码。
- fromCardId
- fromBenefitType
- toBenefitType
- amount
- currency
- transferId
- status
- fromAvailableBalance
- toAvailableBalance
POST /v1/cards/balance-transfers HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.prepaid Content-Type: application/json { "fromCardId": "CRD-POD-100284", "fromBenefitType": "REFEICAO", "toBenefitType": "ALIMENTACAO", "amount": 80.00, "currency": "BRL" }{ "transferId": "BTR-10291", "fromCardId": "CRD-POD-100284", "fromBenefitType": "REFEICAO", "toBenefitType": "ALIMENTACAO", "amount": 80.00, "currency": "BRL", "status": "APPROVED", "fromAvailableBalance": 762.35, "toAvailableBalance": 690.40 }
数据类别
- 卡余额
- 对账单
- 交易记录
- TED 转账
- boleto 付款
- 虚拟卡
- QR 支付
- 持卡人资料
数据使用场景与案例
工资单 PAT 对账
HR 与薪酬机器人在雇主每次充值后,按 benefitType(ALIMENTACAO、REFEICAO、MOBILIDADE、CULTURA、POD)拉取 availableBalance、blockedBalance 和 natalBalance,并在对账单上标出 RETURN_BENEFIT 追回。
餐补与出行费用分析
支出工具摄取 transactionId、merchantName、mcc、amount 以及 APPROVED/DENIED 状态,按钱包绘制每日消费图表,无需抓取 extrato 页面。
激励钱包的 boleto 与 TED
应付账款流程先校验 typedLine,再从 Pagamentos / Incentivo / Pod 卡发起 PAYMENT 类 boleto 或 TED 转账,涉及 bankCode、agency、feeAmount 与 receiptId。
丢卡解锁与虚拟卡号
卡片运营席位用 unlockReason NEW_PLASTIC 调用解锁,并生成 Natal 或外卖专用的 virtualCardId(panLast4、expiryMonth),让员工在替换实体卡还在 TrackingCardActivity 中配送时仍能继续付款。
常见问题
卡片列表里会出现哪些 Alelo 钱包?
首页轮播会还原 Alelo Refeição、Alimentação、Cultura、Mobilidade、Multibenefícios、Pod、Tudo、Natal、Incentivo/Premiação、Pagamentos 和 vale-transporte,每个钱包各带 benefitType、availableBalance 与 last4Digits。
TED 与 boleto 付款怎么表示?
TED 提交 bankCode、agency、accountNumber、transferPurpose 和 feeAmount,返回 tedId。boleto 先把 barcode/typedLine 校验成 beneficiaryName、documentAmount 与 dueDate,再以 paymentType PAYMENT 从所选卡扣款。
Alelo Pod 还有哪些额外钱包?
Pod 在一张实体卡上拆分餐券与食品券价值(podVoucherText 对 podCreditText),支持在 fromBenefitType 与 toBenefitType 之间做 balance-transfers,通过 paymentKey QRPAYMENT 使用 Elo QR,还有面向外卖应用的 Natal 虚拟卡。
除消费外,对账单还有哪些类型?
statementType 包括 MAINTENANCE_FEE_PAT、INACTIVITY_FEE_PAT、BLOCKED_BALANCE、UNBLOCKED_BALANCE、TRANSFER_BLOCKED_BALANCE、RETURN_BENEFIT,以及 PPG 激励卡的费用变体。
与 Meu Alelo 相似的应用
- Pluxee Brasil — Pluxee Brasil 是 Pluxee 餐补、食品、文化、礼品、玩具、燃油与激励卡的官方持卡人应用,可查余额和账单、看受理商户地图、修改 PIN,并在遗失或被盗时冻卡。
- SuperApp VR — SuperApp VR 是 VR Benefícios 面向职工的应用,用来查看餐补、食品券、居家办公和用车津贴余额,查找受理商户,并用虚拟卡或二维码付款。
- Ticket — Ticket 是 Edenred 在巴西的员工福利品牌;官方应用可登记 Ticket Restaurante、Alimentação、Flex、Transporte 和 Cultura 卡,查询余额、账单和受理网点。
- Caju — Caju 是巴西的弹性福利钱包,把餐补、食品、文化、健康、教育、出行、交通券和居家办公津贴放在一张卡上,按品类记账,职工可以把余额转到其他品类。
- Flash — Flash 是巴西的多福利 Visa 卡及职工应用,覆盖 PAT 食品券与餐券以及出行、文化、健康、教育和居家办公等品类,支持实时余额、账单和锁卡。
- CAIXA Refeição e Alimentação — CAIXA Refeição e Alimentação 是巴西联邦储蓄银行(Caixa Econômica Federal)的 PAT 餐补与食品券应用,用来查询余额、账单和受理商户网络。
相关主题
- Meu Alelo API
- Alelo 卡余额
- 巴西 PAT 福利券
- Alelo Pod
- Alelo TED 转账
- Alelo boleto
- Alelo 虚拟卡
- 员工福利钱包
需要集成这个 App 的数据 API?
我们可为任意指定 App 交付定制集成——源码交付 USD 500 起,或托管 API 按调用计费。告诉我们您需要的数据即可。
- 每个项目均签 NDA 与 SOW
- 3–7 天交付
- 验收通过后才付款
- 仅在授权范围内作业