Meu Alelo Data API

Alelo · Payments 4.8 ★

Meu Alelo is the official consumer app from Alelo, the Brazilian employee-benefits issuer behind PAT meal and food vouchers plus culture, mobility, incentive and multi-benefit plastics. After a CPF login with password, OwnID passkey or MFA, the home carousel lists every wallet the worker holds — Alelo Refeição, Alelo Alimentação, Alelo Cultura, Alelo Mobilidade, Alelo Multibenefícios, Alelo Pod, Alelo Tudo, Natal, Incentivo/Premiação, Pagamentos and vale-transporte — with unlock, PIN change, loss-or-theft block, card tracking and a virtual-card face for delivery apps. The payments area runs Elo QR, TED, contactless tap, boleto and Google Pay; the same session opens pharmacy discounts (ePharma), health packages, exclusive offers, Veloe toll tags, AppGas, Pede Pronto delivery pay, Rende Mais yield, a Digio FGTS-anniversary loan and an acceptance-network map. Published for Brazil only, it holds a 4.8 rating across 1.57 million Google Play reviews and 10 million-plus installs, and it competes for the same PAT wallets as Pluxee Brasil, VR Benefícios, Ticket (Edenred Brasil), Caju and Flash Benefícios.

PAT purse lines carry availableBalance and blockedBalance tagged with a benefitType (ALIMENTACAO, REFEICAO, MOBILIDADE, CULTURA, NATAL, MULTIBENEFICIOS, POD, PAGAMENTOS, INCENTIVO) plus last4Digits and cardStatus. Statement rows add statementType values such as MAINTENANCE_FEE_PAT, INACTIVITY_FEE_PAT, BLOCKED_BALANCE and RETURN_BENEFIT; purchases land as transactionId with merchantName and APPROVED/DENIED status.

TED payloads use bankCode, agency and feeAmount; boletos validate a typedLine before debiting the selected card; Elo QR and Natal virtual cards mint virtualCardId / panLast4. Payroll reconcilers, expense tools and lost-card desks consume those fields — openData Studio turns them into callable open data.

Screenshots

API surface

Request/response examples are illustrative, reconstructed from the app's interface — not a live capture.

Prepaid authentication

POST /v1/auth/prepaid/token opendata

Exchanges CPF credentials (or a passkey/MFA challenge) for the prepaid access token used on every subsequent wallet call.

Auth: None. CPF plus password, OwnID passkey or MFA OTP mint accessToken; later calls send 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"
}

Current cardholder profile

GET /v1/users/me osint

Returns the signed-in cardholder — name, CPF, email, phone and preferred Brazilian state — for profile and contact-update screens.

Auth: Bearer token from /v1/auth/prepaid/token.

userId
fullName
cpf
email
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
}

List benefit cards and balances

GET /v1/cards openfinance

Lists every PAT and prepaid wallet on the home carousel with productName, benefitType, availableBalance, blockedBalance and Natal purse.

Auth: Bearer token from /v1/auth/prepaid/token.

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

Card statement

GET /v1/cards/{cardId}/statement openbanking

Returns statement rows for a card, including PAT maintenance/inactivity fees, judicial blockedBalance movements and RETURN_BENEFIT clawbacks.

Auth: Bearer token from /v1/auth/prepaid/token.

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

Card transactions

GET /v1/cards/{cardId}/transactions openbanking

Pages purchase history for a wallet with merchantName, MCC, amount and APPROVED/DENIED status for the extrato and purchase-details screens.

Auth: Bearer token from /v1/auth/prepaid/token.

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

Validate boleto barcode

POST /v1/payments/barcode/validate openfinance

Decodes a scanned or typed boleto linha digitável into beneficiaryName, documentAmount and dueDate before the pay-boleto confirmation screen.

Auth: Bearer token from /v1/auth/prepaid/token.

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

Pay boleto from selected card

POST /v1/payments openfinance

Debits a boleto from the selected Pagamentos / incentive / Pod card and returns paymentId, receiptId and APPROVED status.

Auth: Bearer token from /v1/auth/prepaid/token; card PIN / biometrics on device for the security module.

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

Create TED transfer

POST /v1/transfers openbanking

Sends a TED from an Alelo Pagamentos / incentive / Pod purse to a Brazilian bank account, returning tedId, feeAmount and processing status.

Auth: Bearer token from /v1/auth/prepaid/token; security-module PIN / biometrics. Fee quoted first via the transfer-fee host.

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

Issue virtual card

POST /v1/cards/{cardId}/virtual-cards openfinance

Mints a virtual PAN against a plastic (including a Natal-specific VCN for delivery apps) and returns panLast4, expiry and natalBalance.

Auth: Bearer token from /v1/auth/prepaid/token; card password on the virtual-card password fragment.

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

Unlock card

POST /v1/cards/{cardId}/unlock openfinance

Activates a newly issued or previously blocked plastic after the holder confirms the card password.

Auth: Bearer token from /v1/auth/prepaid/token; card password on the unlock step fragments.

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

Pay with Elo QR

POST /v1/payments/qr openfinance

Pays a merchant QR from the selected Pod/PAT wallet (Elo QR when enabled) after the virtual card is created and unblocked.

Auth: Bearer token from /v1/auth/prepaid/token; QR security module plus an unlocked virtual card on 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"
}

Transfer balance between Pod purses

POST /v1/cards/balance-transfers openfinance

Moves value between Alelo Pod meal and food purses (and similar multi-purse products) and returns both sides' availableBalance.

Auth: Bearer token from /v1/auth/prepaid/token; card password on 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
}

Where teams use this data

Payroll PAT reconciliation
HR and payroll bots pull availableBalance, blockedBalance and natalBalance per benefitType (ALIMENTACAO, REFEICAO, MOBILIDADE, CULTURA, POD) after each employer load and flag RETURN_BENEFIT clawbacks on the statement.
Meal-and-mobility expense analytics
Spend tools ingest transactionId, merchantName, mcc, amount and APPROVED/DENIED status to chart daily spend by purse without scraping the extrato screen.
Boleto and TED from incentive purses
Accounts-payable flows validate a typedLine, then post PAYMENT boletos or TED transfers with bankCode, agency, feeAmount and receiptId from Pagamentos / Incentivo / Pod cards.
Lost-plastic unlock and virtual PAN
Card-ops desks call unlock with unlockReason NEW_PLASTIC and mint a Natal or delivery virtualCardId (panLast4, expiryMonth) so the worker can keep paying while the replacement plastic is in TrackingCardActivity.

Frequently asked questions

Which Alelo wallets show up on the card list?

The home carousel reconstructs Alelo Refeição, Alimentação, Cultura, Mobilidade, Multibenefícios, Pod, Tudo, Natal, Incentivo/Premiação, Pagamentos and vale-transporte, each with its own benefitType, availableBalance and last4Digits.

How are TED and boleto payments represented?

TED posts bankCode, agency, accountNumber, transferPurpose and feeAmount and returns tedId. Boletos first validate barcode/typedLine into beneficiaryName, documentAmount and dueDate, then debit the selected card as paymentType PAYMENT.

What extra purses does Alelo Pod expose?

Pod splits meal and food value on one plastic (podVoucherText vs podCreditText), supports balance-transfers between fromBenefitType and toBenefitType, Elo QR via paymentKey QRPAYMENT, and a Natal virtual card for delivery apps.

Which statement types appear besides purchases?

statementType includes MAINTENANCE_FEE_PAT, INACTIVITY_FEE_PAT, BLOCKED_BALANCE, UNBLOCKED_BALANCE, TRANSFER_BLOCKED_BALANCE, RETURN_BENEFIT and the PPG incentive-card fee variants.

Apps similar to Meu Alelo

Pluxee Brasil — Pluxee Brasil is the official cardholder app for Pluxee meal, food, culture, gift, toy, fuel and incentive cards, covering balance, statements, a merchant map, PIN changes and loss-or-theft blocks.
SuperApp VR — SuperApp VR is VR Benefícios' worker app for tracking Meal Allowance, Food Allowance, Home Office and Auto balances, locating accepting merchants and paying with a virtual card or QR code.
Ticket — Ticket is Edenred's Brazilian employee-benefits brand; its official app registers Ticket Restaurante, Alimentação, Flex, Transporte and Cultura cards so holders can check balance, statements and the accredited merchant network.
Caju — Caju is a Brazilian flexible-benefits wallet that puts meal, food, culture, health, education, mobility, vale-transporte and home-office stipends on one card with per-category balances the worker can reallocate.
Flash — Flash is a Brazilian multi-benefit Visa card and worker app for PAT food and meal vouchers plus mobility, culture, health, education and home-office categories, with live balance, statements and card lock.
CAIXA Refeição e Alimentação — CAIXA Refeição e Alimentação is Caixa Econômica Federal's app for its PAT meal and food benefit cards, used to check balance and statements and to look up the accredited merchant network.

More Payments apps

Topics

meu alelo api
alelo card balance
PAT voucher Brazil
alelo pod
alelo ted transfer
alelo boleto
alelo virtual card
employee benefits wallet

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

Get a quote

Meu Alelo Data API

Screenshots

API surface

Prepaid authentication

Current cardholder profile

List benefit cards and balances

Card statement

Card transactions

Validate boleto barcode

Pay boleto from selected card

Create TED transfer

Issue virtual card

Unlock card

Pay with Elo QR

Transfer balance between Pod purses

Data categories

Where teams use this data

Payroll PAT reconciliation

Meal-and-mobility expense analytics

Boleto and TED from incentive purses

Lost-plastic unlock and virtual PAN

Frequently asked questions

Apps similar to Meu Alelo

More Payments apps

BharatPe for Business

BrasilCard Cliente

BukuWarung Apps for MSMEs

CashBook - Balance & Expense

Topics

Need this app's data API integrated?

Meu Alelo Data API

Screenshots

API surface

Prepaid authentication

Current cardholder profile

List benefit cards and balances

Card statement

Card transactions

Validate boleto barcode

Pay boleto from selected card

Create TED transfer

Issue virtual card

Unlock card

Pay with Elo QR

Transfer balance between Pod purses

Data categories

Where teams use this data

Payroll PAT reconciliation

Meal-and-mobility expense analytics

Boleto and TED from incentive purses

Lost-plastic unlock and virtual PAN

Frequently asked questions

Related apps

Apps similar to Meu Alelo

More Payments apps

BharatPe for Business

BrasilCard Cliente

BukuWarung Apps for MSMEs

CashBook - Balance & Expense

Topics

Need this app's data API integrated?