A secure, robust Home Assistant integration that fetches your PAYBACK points balance, active & available coupons, and account activity directly using TLS-impersonated mobile API clients.
&style=for-the-badge){kind=icon}
| ✨ Features | 📦 Installation | ⚙️ Configuration | 🔐 Session Cookie Guide |
| 🛠️ Options | 🧑💻 Diagnostics | 📄 License |
Instead of brittle web scraping or resource-heavy headless browsers, this integration connects directly using native mobile API endpoints with curl_cffi for advanced TLS-fingerprinted client impersonation. It fetches structured points breakdowns and available deal coupons in real time.
It groups all sensors under a single PAYBACK Account device and implements domain-wide lock serialization, random jitter delays, persistent storage caching, and exponential backoffs to keep your setup safe from rate-limiting bans.
- 🪙 Detailed Points Sensors:
- Total Points: Total accumulated points balance in your account.
- Available Points: Redeemable points available for rewards & discounts.
- Pending Points: Currently locked/pending points from recent transactions.
- 🎟️ Coupon Management:
- Active Coupons: Count of currently activated deal coupons.
- Auto Coupon Activation: Optional background feature to auto-activate new partner coupons.
- 📱 PAYBACK Account Device Grouping:
- All sensors are grouped under a dedicated PAYBACK (Account) device entry.
- Features a direct Visit PAYBACK Account button taking you straight to your web account portal.
- 🛡️ Rate-Limiting & Anti-Ban Protections:
- Lock Queueing: A domain-wide
asyncio.Lockensures concurrent updates run sequentially. - Random Jitter: Introduces a 5–15 second random sleep between requests to avoid timing signatures.
- Restart-Resistance: Saves parsed data to Home Assistant's JSON storage cache to survive restarts without hitting the API.
- Exponential Backoff: Automatic cool-down state (up to 12h) on rate limits or API connection failures.
- Lock Queueing: A domain-wide
- 🔍 Diagnostic Downloads:
- Full support for Home Assistant UI Diagnostics. Download complete configurations with credentials and tokens automatically redacted.
I maintain this integration in my free time alongside my regular job.
This project is and will always remain 100% free.
Donations are completely voluntary — but they help me stay motivated and dedicate more time to maintaining open-source tools!
This integration is fully compatible with HACS.
- Open HACS in Home Assistant.
- Click on the three dots in the top right corner and select Custom repositories.
- Add
https://github.com/FaserF/ha-paybackwith category Integration. - Search for "PAYBACK Deutschland".
- Install and restart Home Assistant.
- Download the latest release zip file.
- Extract the
custom_components/paybackfolder into your Home Assistant'scustom_componentsdirectory. - Restart Home Assistant.
- Navigate to Settings > Devices & Services in Home Assistant.
- Click Add Integration and search for PAYBACK Deutschland.
- Enter your Payback Customer Number / Email and Password.
- (Optional) Paste your browser session cookie string (
incap_ses...) to bypass Cloud WAF bot checks.
Payback utilizes Imperva/Incapsula Cloud WAF bot protection. If live API queries are blocked by WAF challenges, provide a desktop browser session cookie string:
| Step | Action |
|---|---|
| 1. Login | Open Chrome or Firefox on your computer and navigate to PAYBACK.de Coupons. Log in with your credentials. |
| 2. Developer Tools | Press F12 (or Right-Click anywhere -> Inspect). |
| 3. Network Tab | Switch to the Network (Netzwerk) tab at the top. |
| 4. Refresh Page | Press F5 to reload the page with network recording enabled. |
| 5. Select Request | Click on any HTTP request starting with coupons or account. |
| 6. Copy Cookie | In the Request Headers section on the right, find Cookie: and copy the full text string (containing incap_ses_... or visid_incap_...). |
| 7. Paste in HA | Paste the copied string into the Session Cookie field during setup or in the integration Configure menu. |
Click Configure on the PAYBACK integration card to adjust settings:
- Update Interval: Update frequency in hours (default: 12 hours, min: 2 hours).
- Auto Activate Coupons: Automatically activate all available partner coupons in the background.
- Session Cookie: Update or refresh your browser session cookie string at any time.
If you encounter issues, you can download a full diagnostics export: Go to Settings > Devices & Services > PAYBACK Deutschland > 3 Dots > Download diagnostics. All credentials and card numbers are automatically redacted.
Distributed under the MIT License. See LICENSE for more information.